Repository navigation
Update Scaffold Docs - #2708
Update Scaffold Docs#2708zachfedor wants to merge 6 commits into
Conversation
Instead, keep evergreen commands and info but point to stellarscaffold.org site for single source of truth on updated documentation, API reference, quickstart, tutorials, etc.
There was a problem hiding this comment.
Pull request overview
Renames Scaffold documentation to “Stellar Scaffold” and redirects detailed guidance to its synchronized external documentation.
Changes:
- Updates naming, links, and navigation.
- Condenses duplicated setup instructions.
- Refreshes toolkit and registry descriptions.
Recommendation: NEEDS-CHANGES — update the stale “Scaffold Stellar” entry in static/llms.txt.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/tools/scaffold-stellar.mdx |
Rewrites the toolkit overview. |
docs/tools/README.mdx |
Updates the tools listing. |
docs/tools/openzeppelin-contracts.mdx |
Renames the Scaffold package reference. |
docs/build/smart-contracts/getting-started/README.mdx |
Updates the quick-start recommendation. |
docs/build/smart-contracts/getting-started/hello-world-frontend.mdx |
Condenses frontend setup guidance. |
config/theme/navbar.ts |
Updates the navigation label. |
Old repo description for Scaffold still referenced Registry which has since spun out into its own repo, so add Registry as its own entry to this list and update descriptions.
|
After discussing with @oceans404, I went ahead and updated the filename/route and added a redirect rule. Let me know if I need to do anything else, though, because it looks like the check is failing. |
|
Verified this branch on a local build. Pagination, sidebar, breadcrumbs, and section page count match production. The nginx redirect, routes.txt, llms.txt, and navbar entries are consistent. Both crate names resolve on crates.io. All new external links work except one. One blocker: https://stellarscaffold.org/img/code_hero.svg returns 404. The hero image on the new page renders broken. Please point it at a working asset, or commit the image to static/img and reference it locally. The check-routes-removal failure is not a content problem. That workflow only posts a warning comment when routes.txt loses a line, and the post gets a 403 on fork PRs. Your redirect already satisfies what the warning asks for. |
|
🤖 Automated message from Kaan's Automated Triage Bot. Reviewing because a review was requested by @ElliotFriend. The hero image is still broken. Everything else verifies: the rename is complete, the route and redirect work, and every other link resolves. |
kaankacar
added
the
bot:needs-author
… steps Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QhmaWLv4yExX8LahP5UtUb
|
🤖 Automated message from the Stellar Triage Bot. Back on this because @zachfedor pushed a new commit. Thanks for the update. The install steps and the
Can you merge and deploy that PR, then reply here? I will recheck the image and update the label. ( |
Updates documentation following rename to "Stellar Scaffold" along with new GitHub organization and documentation website.
Also reduces some duplicated quickstart/tutorial info that is spread around the docs site. This became difficult to maintain in multiple places after any change to Scaffold's API. Instead, this adds pointers to our official documentation site which is deployed in lock-step with code changes ensuring there's a lot less outdated info.
NOTE: I did not change the file name since I didn't know how you all want to handle redirects. I can update that too, but the diff will be easier to read for now.