Skip to content

Docs: revamp the mdBook - #30

Merged
cusma merged 7 commits into
mainfrom
docs/mdbook-revamp
Nov 3, 2026
Merged

cusma merged 7 commits into
mainfrom
docs/mdbook-revamp

Conversation

@cusma

@cusma cusma commented Nov 3, 2026

Copy link
Copy Markdown
Owner

No description provided.

cusma added 7 commits November 3, 2026 12:41
- Set site-url so the 404 page works under /pposdex/
- Add description, GitHub link and "Suggest an edit" button
- Fail the build on missing chapters instead of creating them
- Simplify the local preview instructions in the README
- Descriptive page names instead of numeric prefixes
- Redirect every old page URL to its new location, anchors included
- Fix "Poof of Stake" typo in the table of contents
- Turn disclaimer, assumptions and references blockquotes into typed
  admonitions (warning, note, important, tip)
- Drop decorative horizontal rules around page content
- Pages include each command's --help from docs/cli/help, kept in sync
  with the CLI by a test
- Replace the outdated publish example with current output
- Drop the stale docopt-style option lists
- Oracle account on Lora instead of the defunct AlgoExplorer
- Nodely API docs
- Algorand developer portal pages moved to dev.algorand.co
- On PRs, check links between pages, images and anchors offline
- Weekly, check external links and report broken ones in an issue
  without failing the run
- Canonical GitHub contributing guide with the development setup,
  moved from the README
- Redirect the docs contributing page to it and link it from the cover
@cusma cusma self-assigned this Nov 3, 2026
@cusma cusma added the documentation Improvements or additions to documentation label Nov 3, 2026
@cusma
cusma merged commit 3944a84 into main Nov 3, 2026
9 checks passed
@cusma
cusma deleted the docs/mdbook-revamp branch November 3, 2026 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant