Recommend a canonical graphql.config.yml for Harper schemas
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- nodejs
- Domain
- documentation
Research direction
Start with reference/database/schema.md and run the mentioned rg search across reference/, learn/, and fabric/. Verify whether npm create harper@latest scaffolds graphql.config.yml and compare the proposed file with the project's supported tooling. Done means documenting the confirmed recommendation, directive schema location, and scaffold behavior without leaving the tooling choice unresolved.
Written by the indexing model from the issue text.
Description
Gap
The harper-best-practices skill rule for schema-design-tooling recommends a specific `graphql.config.yml` setup so editors and the GraphQL language server can resolve Harper directives:
```yaml
schema:
- node_modules/harper/schema.graphql
- schemas/*.graphql
```
(Pointing the language server at `node_modules/harper/schema.graphql` is the part that's Harper-specific — it's where `@table`, `@indexed`, etc. are defined.)
None of this is in the docs. `rg "graphql.config" reference/ learn/ fabric/` returns nothing.
Ask
Decide whether `graphql.config.yml` is the recommended tooling pattern (vs. `graphqlrc.yml`, vs. configuring per-editor, vs. just documenting where the directive schema lives without prescribing a tooling file). If yes:
- Add a short subsection to `reference/database/schema.md` (or a new page under `reference/database/`) showing the recommended file and what each entry does.
- Note that `node_modules/harper/schema.graphql` is the canonical directive source so readers can also point other tools at it.
- Mention that `npm create harper@latest` scaffolds this file (if it does — needs confirmation).
Context
Surfaced by a reverse gap-scan of the harper-best-practices skill rules.
— Claude (Opus 4.7), on behalf of @kriszyp
- Dominant language
- MDX
- Stars
- 9
- Forks
- 9
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 16
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from HarperFast/documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
HarperFast/documentation#690 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
HarperFast/documentation#677 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 Half a day Newbie friendliness 88/100
HarperFast/documentation#675 ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
HarperFast/documentation#665 ·
Maintainers usually reply within 2 days
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
HarperFast/documentation#478 ·
Maintainers usually reply within 2 days
All issues in HarperFast/documentation
Similar issues
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 3 days
-
bug developer portal
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
discord/discord-api-docs#8645 ·
Maintainers usually reply within 1 day
-
Form
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
symfony/symfony-docs#23159 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day