Skip to content

Review the user docs against what shipped before the parity gate closes #217

Description

@mmcky

Part of #147 (close-out: the final task before the PLAN.md close-out).

Why

Gate items update their own documentation lines as they land, and their acceptance criteria say which lines. Nothing checks the docs as a whole against the release that closes the gate. The review of #147 also found documentation lines that describe behaviour the theme does not have and that no gate issue owns. Those lines are collected here. #210, closed on 2026-09-11, recorded where every other part went.

Scope

Review README.md, every page under docs/, and CONTRIBUTING.md against the theme as released at the end of the gate. Start with these lines (the permalinks show them at v2.7.0):

Line Says What the theme does Study row
docs/layout.md L7-L10 "A fixed 50px toolbar: the QuantEcon logo and site title, …" The toolbar has no site title, and the Home, font-size and GitHub controls go unmentioned F019
docs/layout.md L52-L53 Below lg (1024px) the outline column is hidden The outline appears from 1280px F001
docs/dark-mode.md L4-L6 "the Sphinx sites' dark ground (#222) and white text" This describes book-theme releases before 0.18.0; 13 lecture repositories pin 0.22.0, which has a navy-charcoal palette. The palette choice is a design question on #187 F029
docs/configuration.md L51 site.title is "the site name in the header and og:site_name" The header shows the project title; site.title feeds og:site_name and the page-title suffix F006
docs/notebooks.md L7 "Long outputs are clipped with a scroll region." Nothing limits output height until QuantEcon/mystmd#106 ships F069
docs/authors.md (not mentioned) The translator credit joins names in English (", " and " and ") on every edition

Also:

Acceptance criteria

  • Every line in the table describes the shipped behaviour, or names the open issue that will change it.
  • Every documentation line named in a closed gate item's acceptance criteria is confirmed updated.
  • docs/index.md points its no-counterpart promise at the migration checklist table, and no docs page presents PLAN.md as the live record of the parity work.
  • README's pinned vX.Y.Z URLs name the release that closes the gate.
  • The PR changes documentation only.

Context

Activity

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

    documentationRepo docs and contributor meta (not lecture content)

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions