Skip to content

Add a short note on choosing an indexer approach - #33

Open
kaankacar wants to merge 2 commits into
mainfrom
demo-selffix
Open

Add a short note on choosing an indexer approach#33
kaankacar wants to merge 2 commits into
mainfrom
demo-selffix

Conversation

@kaankacar

Copy link
Copy Markdown
Owner

Adds one sentence to the Indexers overview pointing readers from off-the-shelf APIs toward self-hosting as they grow.

@stellar-docs-bot

Copy link
Copy Markdown

🤖 Claude docs review

Verdict: NEEDS-CHANGES (small, safe fix — proposed for self-fix below)

Mechanics pass

  • ✗ Typo: "allways" → "always" — docs/data/indexers/README.mdx:115
  • ✓ No links, anchors, headings, images, or code fences added; nothing to resolve or collide.
  • ✓ MDX-safe plain paragraph; no secrets or personal data.

Technical accuracy pass

  • ✓ The advice ("start with an off-the-shelf API, move to a self-hosted indexer as your needs grow") matches the page's own progression (docs/data/indexers/README.mdx:22 off-the-shelf APIs → docs/data/indexers/README.mdx:77 Build Your Own) and current Stellar data-tooling guidance (managed third-party indexers vs. self-hosted Galexie/Ingest SDK pipelines). No protocol, passphrase, RPC/Horizon, SDK, or SEP/CAP claims are made.

Completeness pass

  • ✓ Does exactly what the title/description claims: adds one guidance sentence to the Indexers overview. No referenced issues.

Non-blocking nits (for the author or a maintainer, not part of the self-fix)

  • The sentence is appended after the link-reference definition block (docs/data/indexers/README.mdx:103-113), so it renders as the final paragraph under the "Processors" subsection of "Build Your Own" — an odd spot for a general "still deciding?" note. A more natural home would be at the end of the "What exactly is indexing?" intro or just before "Build Your Own". It also breaks the file's convention of keeping link defs last. Moving it is a judgment call, so I'm not including it in the self-fix.

Proposed self-fix

  • docs/data/indexers/README.mdx:115 — "you can allways change your approach later." → "you can always change your approach later."

@stellar-docs-bot stellar-docs-bot Bot added the pr:autofix Reviewer found small safe fixes it can apply itself label Jul 16, 2026
@stellar-docs-bot

Copy link
Copy Markdown

🤖 Claude docs self-fix

  • docs/data/indexers/README.mdx:115 — fixed typo: "you can allways change your approach later." → "you can always change your approach later."
  • Skipped the non-blocking nit about relocating the sentence above the link-reference definitions — the review marked it a judgment call and excluded it from the self-fix.

The push triggers a fresh review.

@stellar-docs-bot stellar-docs-bot Bot removed the pr:autofix Reviewer found small safe fixes it can apply itself label Jul 16, 2026
@stellar-docs-bot

Copy link
Copy Markdown

🤖 Claude docs review

Verdict: READY-FOR-HUMAN-APPROVAL (re-review of head 3a4b1a3 after the self-fix commit)

Mechanics pass

  • ✓ Prior blocking typo is fixed: "you can always change your approach later" — docs/data/indexers/README.mdx:115
  • ✓ Plain-text paragraph; no links, anchors, headings, images, or code fences added — nothing to resolve or collide.
  • ✓ MDX-safe (no JSX/imports/unclosed tags); no secrets or personal data.

Technical accuracy pass

  • ✓ The guidance (start with an off-the-shelf API, move to self-hosted as needs grow) matches the page's own progression from Portfolio APIs (docs/data/indexers/README.mdx:22) through custom transformation to Build Your Own (docs/data/indexers/README.mdx:77).
  • ✓ Consistent with the current Stellar data-skill reference, which documents both third-party indexers (Mercury, SubQuery, Goldsky) and the self-hosted Galexie/CDP pipeline as the two ends of that spectrum (.stellar-dev-skill/skills/data/SKILL.md).
  • ✓ No protocol/version, passphrase, RPC-vs-Horizon, SDK, or SEP/CAP claims are introduced.

Completeness pass

  • ✓ Title and description promise one advisory sentence on choosing an indexer approach; the diff delivers exactly that (docs/data/indexers/README.mdx:114-115). No referenced issues; no sequencing constraints or related open PRs.

Non-blocking nits (maintainer judgment)

  • The sentence sits after the link-reference definition block (docs/data/indexers/README.mdx:103-113), so it renders at the very end of the page under the "Processors" h3. It renders correctly, but moving it above the definitions (or into its own closing subsection) may read better. Carried over from the prior review as a style call.
  • Whether this editorial recommendation belongs on the overview page at all is a content-tone decision for a docs maintainer — which is why this is not labeled auto-merge-candidate: it adds new advisory prose rather than being a pure typo/link/version/wording fix per the trivial tier.

No action label applied; ready for a human maintainer's approval.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant