Skip to content

Add Ticking explanation page#2011

Open
dnadales wants to merge 1 commit intomainfrom
dnadales/docs-add-ticking-explanation
Open

Add Ticking explanation page#2011
dnadales wants to merge 1 commit intomainfrom
dnadales/docs-add-ticking-explanation

Conversation

@dnadales
Copy link
Copy Markdown
Member

Summary

  • Adds docs/website/contents/explanations/ticking.md: a first-elaboration
    explanation of ticking covering what it is, why it is a distinguished
    operation, where consensus ticks, how it relates to forecasting, and the
    key invariants. Includes one Mermaid diagram of the tick/apply alternation
    and a table of the main call sites.
  • Distilled from the archival references/miscellaneous/ticking.md, which
    remains in place as the deeper reference and now points readers to the new
    explanation.
  • Adds a glossary entry (Tick / Ticking / Ticked) and registers the new
    page in the sidebar.
  • Weaves brief motivating context into consensus_protocol.md's "Ticked
    state" section and adds a framing note at the top of
    ledger_interaction.md's "Ledger state ticking and forecasting" section,
    both linking to the new explanation.

Distills the archival docs/website/contents/references/miscellaneous/ticking.md
into a first-elaboration explanation under Explanations.
Adds a glossary entry, a sidebar entry, and brief cross-links from
consensus_protocol.md and ledger_interaction.md into the new page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

1 participant