Skip to content

fix(docs): improve contract docs with custom landing page and fix links #3888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
sveitser wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): improve contract docs with custom landing page and fix links #3888

sveitser wants to merge 2 commits into from
+80 −4

Conversation

@sveitser
Copy link
Collaborator

@sveitser sveitser commented Jan 14, 2026

  • Add contracts/README.md as custom landing page for published docs
  • Flatten docs structure to avoid /contracts/contracts/src/... URLs
  • Fix inherit links that were broken when deployed under /contracts/
  • Add mdbook to CI workflow for building contract docs
  • Add doc-all-serve recipe to preview full docs locally
  • Output file:// URLs after doc builds for easy access

@sveitser
fix(docs): improve contract docs with custom landing page and fix links
b7f0dd5 
- Add contracts/README.md as custom landing page for published docs
- Flatten docs structure to avoid /contracts/contracts/src/... URLs
- Fix inherit links that were broken when deployed under /contracts/
- Add mdbook to CI workflow for building contract docs
- Add doc-all-serve recipe to preview full docs locally
- Output file:// URLs after doc builds for easy access
@sveitser sveitser enabled auto-merge (squash) January 14, 2026 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jbearer jbearer Awaiting requested review from jbearer jbearer is a code owner

@imabdulbasit imabdulbasit Awaiting requested review from imabdulbasit imabdulbasit is a code owner

@ss-es ss-es Awaiting requested review from ss-es ss-es is a code owner

@pls148 pls148 Awaiting requested review from pls148 pls148 is a code owner

@bfish713 bfish713 Awaiting requested review from bfish713 bfish713 is a code owner

@rob-maron rob-maron Awaiting requested review from rob-maron rob-maron is a code owner

@lukaszrzasik lukaszrzasik Awaiting requested review from lukaszrzasik lukaszrzasik is a code owner

@Ancient123 Ancient123 Awaiting requested review from Ancient123

@alysiahuggins alysiahuggins Awaiting requested review from alysiahuggins

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sveitser