Skip to content

Clarity docs: tag epoch-dependent DocNotices with their activation epoch #7746

Closed

Description

@werner-stacks

Is your feature request related to a problem? Please describe.
The docs site gets its Clarity reference from stacks-inspect docgen; a weekly bot PR regenerates it from main. The function docs in clarity/src/vm/docs/mod.rs already describe Epoch 4.1 behavior (also in 4.0.5), so https://docs.stacks.co/reference/clarity/functions shows rules that are not active on mainnet.

Seven passages are affected: two DocNotices (fold, tuple) and five in descriptions (principal-destruct?, from-consensus-buff?, define-public, define-read-only, define-trait). The define-read-only sentence does not name the epoch, so it reads as a current rule: https://docs.stacks.co/reference/clarity/functions#define-read-only

Describe the solution you'd like
My question: can DocNotice get an optional epoch: Option<StacksEpochId> field? The five description passages would move into notices, and all seven would get epoch: Some(StacksEpochId::Epoch41). The docs generator then reads current_epoch from /v2/pox and hides notices for epochs that are not active, so the notes appear on their own when 4.1 activates.

If yes, do you want me to open the PR, or do you prefer to do it?

Describe alternatives you've considered
If you prefer no format change: start the define-read-only sentence with "Beginning in Epoch 4.1,". Then every passage names its epoch, and I keep them as they are.

Additional context

Activity

  1. brice-stacks commented on Oct 15, 2026

    @brice-stacks
    Contributor

    I'd prefer that the text indicates anything that applies to a specific epoch, since we probably DO want the docs showing upcoming behavior before it is live, so developers can prepare.

  2. moved this from Status: 🆕 New to Status: ✅ Done in Stacks Core Engon Oct 16, 2026
  3. github-actions commented on Oct 24, 2026

    @github-actions

    Closed Issue has been locked after 7 days of inactivity.

  4. locked as resolved and limited conversation to collaborators on Oct 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions