Skip to content

3.0 release#1011

Merged
ryanwaits merged 275 commits intomainfrom
develop
Jul 18, 2025
Merged

3.0 release#1011
ryanwaits merged 275 commits intomainfrom
develop

Conversation

@ryanwaits
Copy link
Contributor

@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, T technical content complete
Chainhook S, N, T technical content complete
Contract Monitoring S, N, T technical content complete
Bitcoin Indexer S, N, T 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, N needs updated content
Clarinet JS SDK / Browser S, N, T ready across the board

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

@janniks
Copy link
Contributor

janniks commented Jul 10, 2025

Tabs are a bit hard to read and UI could be clearer.

Screenshot 2025-07-11 at 01 04 01

@janniks
Copy link
Contributor

janniks commented Jul 10, 2025

Minor bug in the type setting of this callout.

Screenshot 2025-07-11 at 01 03 18

@ryanwaits ryanwaits changed the title docs 2.0 (phase I) 3.0 release Jul 12, 2025
@ginny-d
Copy link

ginny-d commented Jul 17, 2025

Hey Ryan, great work, it's so much clearer!

Here's some feedback for this first release

  1. The paragraph font color contrast is not great on dark mode. Currently it's set on #8c877d, setting it on #B5ACA1 would improve readability
Screenshot 2025-07-17 at 12 17 53 Screenshot 2025-07-17 at 12 18 01
  1. Some link styles, specially on dark mode, are not very visible. Here I didn't realise these were link until I happened to hover on them. Could we make link styles more similar to the ones in the styleguide?
Screenshot 2025-07-17 at 12 18 17 Screenshot 2025-07-17 at 12 44 24 Screenshot 2025-07-17 at 12 51 09

Or, just a simple underline like used here would be ok:
Screenshot 2025-07-17 at 14 37 09


  1. It'd be handy if we can include a copy button to all code blocks. Edit: I've seen some blocks that have it, but others don't 🤔
Screenshot 2025-07-17 at 12 46 07
  1. On Contract Monitoring, the title of the section is missing on the sidebar
Screenshot 2025-07-17 at 12 42 07

I would also suggest, both for Contract Monitoring and Bitcoin Indexer (and any other pages with a single section), to merge the sections into a single one, so it would be:

Contract Monitoring

  • Overview
  • Create an alert

Bitcoin Indexer

  • Overview
  • Node installation
  • Full sync
  • Archive bootstrap
  • Configuration
Screenshot 2025-07-17 at 12 43 00

@ginny-d
Copy link

ginny-d commented Jul 17, 2025

Also, here are updated diagrams:

overview-btcindex
overview-chainhook
overview-stacksapi

@ginny-d
Copy link

ginny-d commented Jul 17, 2025

A couple more:

  1. In this last "Configuration" page on Bitcoin Indexer, the 'Next steps' pages link to the two previous pages, which I thought it was odd to take me back for next steps. I'd suggest removing them
Screenshot 2025-07-17 at 14 33 31
  1. I encountered some different tab styling. In the installation one, it wasn't evident to me at first that those were tabs
Screenshot 2025-07-17 at 14 32 43 Screenshot 2025-07-17 at 14 28 55

Could we use the styling we were using before?
Screenshot 2025-07-17 at 14 40 19


  1. It'd be helpful to have the legend before the tables, and not at the end
Screenshot 2025-07-17 at 14 35 32

Copy link
Contributor

@ECBSJ ECBSJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ryanwaits ryanwaits merged commit 3674693 into main Jul 18, 2025
3 checks passed
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.

5 participants