Skip to content

[Rosetta-0] Audit and freeze current docs and matrix #864

Description

@k5602

Goal

Record exact docs debt. Freeze baseline so later diffs stay reviewable.

Tasks

  • List all files under docs/ with line counts and status: active, stub, stale.
  • Record empty headings in docs/README.md: section 6 API, 5.3.1.1-5.3.1.7, 5.3.2.1-5.3.2.2, 5.3.3.1, 5.5 Serialization, 5.6 Memory Layout.
  • Record TOC bug: 4.2 and 4.3 nested under 4.1 though headings are level 3 siblings.
  • Record branch mix: docs/README.md uses master image links, README.md uses develop.
  • Record broken ref: .github/PULL_REQUEST_TEMPLATE.md links to docs/README.md#63-debugging, actual section is 7.3.
  • Inventory loaders: 21 wired in source/loaders/CMakeLists.txt plus orphans source/loaders/deno_loader/ and source/loaders/kind_loader/ with no CMake entry.
  • Inventory ports: 15 wired in source/ports/CMakeLists.txt, plus nim_port/ and scala_port/ unwired. Note anomaly: OPTION_BUILD_PORTS_TS exists but source/ports/ts_port/ dir is absent.
  • Inventory tests: ~175 targets in source/tests/CMakeLists.txt (verify exact active count), list disabled suites and linked issue IDs.
  • Check .github/workflows/ coverage: linux, windows, macos, freebsd, haiku, android-test, benchmark, clang-format, docker-hub, release.
  • Publish audit table in this issue. Lock scope for Rosetta-1 to Rosetta-8.

Acceptance

  • Audit table posted with file paths and counts.
  • Orphan and disabled lists confirmed by maintainer.
  • No docs edits in this issue except audit report.

Activity

  1. added
    documentationUpdates or improvements to the documentation
    on Sep 6, 2026
  2. vishwastiwariii commented on Sep 9, 2026

    @vishwastiwariii

    Is anyone on this? The first two boxes are ticked, so I want to check before picking up the rest.

    If it's free, I'll take the remaining items and post the audit as a single comment, no doc edits.

    Three questions first:

    1. Which commit should the baseline be pinned to? The counts are only reviewable later if the table states the SHA they were taken at.
    2. For the test inventory, does "active" mean targets that build in a default configuration, or all declared targets regardless of their OPTION_BUILD_* guard?
    3. What's the stub vs stale rule for docs/? I'd default to stub = heading with no meaningful body, stale = references paths or APIs that have moved, but happy to use yours.

    I'll also flag OPTION_BUILD_PORTS_TS with no ts_port/ directory, and the two orphan loaders, as open questions in the table rather than guessing at intent.

  3. AgrimGupta195 commented on Sep 24, 2026

    @AgrimGupta195

    Hi @k5602 , checking in on this — looks like the remaining items are still open. Happy to pick up the TOC bug, branch mix, and broken ref items if that's still needed. @vishwastiwariii let me know if you're still planning to work on this, don't want to duplicate.

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

    documentationUpdates or improvements to the documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions