Skip to content

docs: update the root README layout and guidelines list #22

Closed

Description

@homer6

Part of #20. The root README.md "Layout" section still marks strings/, algorithms/, ranges/, utilities/ and language/ as "(planned)", although every area in docs/examples/README.md is done, and it doesn't mention docs/guidelines/ pages added since (tooling, performance tooling, testing, build and packaging), evals/, tools/ or the skills.

Acceptance: README layout matches the real tree; guidelines list matches docs/guidelines/README.md; links pass check_links.py.

Also: update CLAUDE.md → "Source of truth": sources aren't limited to cppreference — any resource (standard draft, WG21 papers, vendor docs, books, talks) is fine as long as the claim has been verified locally (compiled and, where behaviour matters, run with the local toolchain). Pages cite what they used in "See also".

Activity

  1. homer6 commented on Oct 31, 2026

    @homer6
    OwnerAuthor

    Delivered in 822a154 (pushed directly to main at the owner's request).

    What changed

    • README.md: the Layout section now shows the real tree (all 18 library areas, the 11 language areas, guidelines/, tools/, evals/, .claude/skills/, modules/) instead of marking areas "(planned)"; the guidelines list includes tooling, performance tooling, testing, build and packaging; new "Checking the snippets" section; "See also" no longer says cppreference-only.
    • CLAUDE.md → Source of truth: any good source is allowed (cppreference, standard draft, papers, vendor docs, books, talks) as long as each claim is verified locally; lists the local toolchains (GCC 15.2, Homebrew Clang 22 + libc++, Docker gcc:16); unverifiable features get needs= and a note.

    Why

    • The README contradicted docs/examples/README.md (everything done). The sourcing rule follows the owner's instruction to use any resource verified locally.

    Still open

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions