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

Open
  • Is something wrong?
#864 3 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@pranab-mandal is already working on this.

Since Oct 26, 2026.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
cmake, github-actions
Domain
build-system, ci-cd, documentation

Research direction

Start with docs/README.md, README.md, .github/PULL_REQUEST_TEMPLATE.md, and the loader, port, and test CMakeLists.txt files; then inspect .github/workflows/ for the listed platforms and jobs. Produce the requested audit table with paths, counts, statuses, orphaned and disabled entries, and linked issue IDs, and post it here for maintainer confirmation. Keep the issue limited to the audit report, with no documentation edits.

Written by the indexing model from the issue text.

Description

documentation good first issue
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.
Dominant language
C
Stars
1.8k
Forks
266
Avg merge
2d 16h
Merged PRs (30d)
14

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from metacall/core

All issues in metacall/core

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.