Quick Start: add Start Block guidance and Troubleshooting section#1096
Open
franrob-projects wants to merge 1 commit intographprotocol:mainfrom
Open
Conversation
Two additions to the Subgraph Quick Start page, both covering
questions that come up repeatedly for first-time subgraph developers:
1. Tighten the Start Block bullet in the init step and add a callout
explaining how to find the right block on a block explorer, plus
what happens when it's set too low or too high. The previous wording
("input the start block where the contract was deployed") assumes
the reader already knows how to locate that block.
2. Add a Troubleshooting section at the end of the page covering five
common failure modes: codegen ABI errors, expired deploy keys,
subgraphs that sync but return no data, indexing stalls, and the
Studio-vs-CLI choice.
One file changed, 52 insertions.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
franrob-projects
added a commit
to franrob-projects/portfolio
that referenced
this pull request
Apr 21, 2026
- Add TeachYAR and GibTrain (Gibraltar Compliance) project cards. Extend Project interface with an optional live URL and a "Live site" button. GibTrain links to its GitHub Pages deployment. - Add "Open-source contributions" subsection listing five docs PRs: graphprotocol/docs#1096, open-telemetry/opentelemetry.io#9711, redpanda-data/docs#1656, OWASP/CheatSheetSeries#2101 and #2100. Styled with repo code-tag, state pill, and PR number. - Home page copy: "Tech writer" -> "All things docs", "My writer journey" -> "My journey". - Expand the Ably entry with the docs re-engineering work (Textile -> Next.js + TypeScript + React) and link the two merged MDX conversion PRs: ably/docs#2911 (REST API) and #2913 (SSE). - Expand docs/ably/index.md with a new "Re-engineering the docs site" section plus images across SSE, webhooks, pub/sub, troubleshooting, and architecture. Add a troubleshooting subsection linking ably/docs#2984 (HAR file guide) and #2818 (service disruptions). - Rename static/img/ably/ably-troubleshooting/ (drop the trailing space in the directory name that was breaking image references). - Remove em-dashes from site content (projects page, 3 blog post alt-texts) using contextual substitutions: colons for titles and list intros, commas/periods for mid-sentence pauses, parens for a parenthetical, pipe for the HTML page title. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
Two additions to
website/src/pages/en/subgraphs/quick-start.mdx:graph initstep, plus a new> [!NOTE]callout explaining how to find the block a contract was deployed in (via the contract creation transaction on Etherscan or any EVM explorer) and what happens when the value is too low or too high.graph codegen"Cannot find ABI" errorsgraph deployauth failures after key rotationWhy
The Quick Start walks through a happy path but doesn't cover the failure modes that first-time Subgraph developers almost always hit. These five items show up repeatedly in Discord support and in issues against the CLI. Having self-service answers on the Quick Start page reduces the support load and gets new developers unblocked faster.
Scope
One file changed, 52 lines added, 1 modified. No file moves, no new routes, no sidebar changes required.
Alert style uses
> [!NOTE]/> [!IMPORTANT]to match the existing conventions in the repo (confirmed via grep).