docs: sync with latest release flow and delete stale docs#117
Open
silent-cipher wants to merge 5 commits into
Open
docs: sync with latest release flow and delete stale docs#117silent-cipher wants to merge 5 commits into
silent-cipher wants to merge 5 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates how subgraph documentation is maintained and consumed by the subgraph-client, moving away from committed copies in subgraph-client/public/ and toward an automated sync from the source docs under docs/subgraph/. It also refreshes the deployment/GraphQL docs content to reflect the current automated release/deploy workflow.
Changes:
- Add a
subgraph-clientpre-build/dev step to syncdocs/subgraph/*.mdintosubgraph-client/public/docs/subgraph/, with link rewriting for in-app navigation. - Remove previously committed generated docs under
subgraph-client/public/docs/subgraph/and ignoresubgraph-client/public/docs/going forward. - Update
docs/subgraph/deployment.md,docs/subgraph/graphql-api.md, and rootREADME.mdto match the latest release/deployment flow and terminology.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| subgraph-client/scripts/sync-docs.js | New script to copy source docs into the client’s static public/ tree and rewrite in-app doc links. |
| subgraph-client/public/docs/subgraph/graphql-api.md | Removes committed generated doc (now produced by sync script). |
| subgraph-client/public/docs/subgraph/deployment.md | Removes committed generated doc (now produced by sync script). |
| subgraph-client/package.json | Runs doc sync automatically via predev and prebuild. |
| subgraph-client/Dockerfile | Deletes the client Dockerfile (presumably no longer used for deployment). |
| subgraph-client/.gitignore | Ignores generated public/docs/ output from the sync script. |
| README.md | Updates top-level usage/deploy guidance and removes stale mockup section. |
| docs/subgraph/graphql-api.md | Updates GraphQL API reference content/terminology and adds newer entity/query docs. |
| docs/subgraph/deployment.md | Rewrites deployment docs to reflect automated release-please production deploy plus manual/dev flow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.