Skip to content

docs 2.0 (phase I) #1011

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.

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

Open
wants to merge 195 commits into
base: main
Choose a base branch
from
Open

docs 2.0 (phase I) #1011

wants to merge 195 commits into from

Conversation

ryanwaits
Copy link
Collaborator

@ryanwaits ryanwaits commented Jun 2, 2025

What does this PR do?

docs 2.0 (phase I)

the goal of phase I is to ship the revamped information architecture and navigation for docs 2.0 plus the first batch of refreshed technical content so we can gather feedback on flow, discoverability, and overall developer experience improvements.

what to review and how - we are trying a three-label system so each reviewer knows what kind of feedback is actually actionable right now:

Label Description
S structural / design review (layout, components, readability)
N navigation / IA / flow review (top-nav, sidebar, breadcrumbs, cross-links)
T technical-content review (accuracy, completeness, examples)
Section Ready Notes Done
Homepage S, N, T mostly unchanged, ready for any kind of review
Clarinet S, N ~95% technical content complete
Chainhook S ~70% technical content complete
Contract Monitoring ~80% technical content complete
Bitcoin Indexer ~50% technical content complete
API references S, N, T reference pages overhauled and playground refreshed.
API page content old guide pages untouched. not ready for full review
ai/llms.txt S, N, T additional eval testing also welcome
Stacks.js S needs updated content
Clarinet JS SDK / Browser S, N, T ready across the board
Stacks Blockchain Client not ready

what is excluded in phase I - these areas and sections stay frozen; no feedback needed until phase II or later:

  1. guides
  2. snippets
  3. clarity
  4. hiro archive

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.

3 participants