Repository navigation
Update Scaffold Docs - #2708
Update Scaffold Docs#2708zachfedor wants to merge 2 commits into
Conversation
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. |
|
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
|
🤖 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. ( |
- Adds `img/scaffold-hero.png`: a terminal running `init` and `npm run dev` beside the React template in the browser - Unblocks the hero image on Stellar's developer docs page, stellar/stellar-docs#2708, which currently links to a removed asset 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01QhmaWLv4yExX8LahP5UtUb Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
|
Merged and deployed! |
|
🤖 Automated message from the Stellar Triage Bot. Back on this because @zachfedor replied. Thanks! The hero image loads now, so the content is ready. One blocker remains: main moved to Mintlify in #2941, and this branch now conflicts in 9 files. I cannot push the merge for you, because it brings in workflow changes. Can you rebase onto main and port the edits?
|
a3bd543 to
acb392e
Compare
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
acb392e to
33f5c03
Compare
stellar-triage-bot
Bot
added
bot:ready-to-merge
|
🤖 Automated message from the Stellar Triage Bot. Back on this because @zachfedor pushed the Mintlify port. Verified: the port matches the content I checked before, the redirect and External-origin change, so a maintainer merges this. |
ElliotFriend
left a comment
ElliotFriend
left a comment
There was a problem hiding this comment.
Thanks for porting this to Mintlify, and for keeping the redirect from the old /docs/tools/scaffold-stellar path. One small thing on docs/tools/stellar-scaffold.mdx: the "officially sanctioned Stellar Development Foundation Public Good" line links to the grants and funding page, which doesn't say that. Could we rewrite that sentence, or link to a source that says it? Once that's sorted, I'll approve the preview run and merge.
|
🤖 Automated message from the Stellar Triage Bot. Back on this because @ElliotFriend reviewed. Done in 6c31502. The grants page does not call Scaffold a Public Good, so I removed that claim. The sentence now says it is open source under Apache 2.0 and actively maintained. Both facts come from the stellar-scaffold/cli repo. External-origin change, so a maintainer merges this. A maintainer can build the preview: open the Mintlify Preview (fork) check and click Approve preview. |
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.