Skip to content

Docs: prepare the repository for public contributors - #99

Merged
DJAscendance merged 4 commits into
masterfrom
docs/public-release
Oct 29, 2026
Merged

DJAscendance merged 4 commits into
masterfrom
docs/public-release

Conversation

@DJAscendance

Copy link
Copy Markdown
Member

Closes #98

Summary

Prepares the public repository for outside contributors. Documentation and repository files only; no source, test, pin or baseline changes.

Changes

  • LICENSE: MIT, copyright Ascendance3D. NOTICE points to it. Cargo.toml already declares MIT.
  • README.md: rewritten for contributors. It covers what the project is, status, working and missing features (with issue links), targets, requirements, build, test, usage, layout, attribution, license, contributing, and links to Issues and CI.
  • docs/TESTING.md and docs/EMBEDDING.md: the detailed sections of the old README, moved unchanged (reference pin, tests, modes, C0 suite; host services and events). The per-commit test baseline table is removed; Git history keeps it.
  • CLAUDE.md (AGENTS.md is a symlink to it): the private-visibility rule is replaced by the public-repository rules.
  • PROVENANCE.md: removes the "PRIVATE" mark and a private report path.
  • .gitignore: adds the CI output files suite.log and evidence-skips.tsv.
  • rust-tests.yml: one comment now points to docs/TESTING.md. No step changes.

Verification (local, Rust 1.95.0, at a513240)

command result
tools/fetch-upstream.sh reference ACCEPTED (4ca3d05, 5.65.21, 440 files)
cargo fmt --all -- --check pass
cargo build --workspace pass
cargo build --release -p cm-view --bin cm-edit pass
cargo test --workspace --no-fail-fast (strict) 800 passed, 0 failed, 0 ignored
same with CM_EVIDENCE=ci CM_EVIDENCE_ALLOW=no-gpu-adapter,tool-absent 800 passed, 0 failed, 0 ignored
./target/release/cm-edit Cargo.toml --mode text/x-toml (under xvfb-run) window opened and ran until the 6 s timeout
README run_mode_collect example, compiled in a scratch crate prints the expected TOML tokens

The browser runs (tools/web-test.sh) and the C0 suite are described but not run here; their text moved unchanged.

Ledger effect

None: documentation only.

Not in this PR

  • oracle/corpus-items/ (859 files) is a snapshot of historical Mall items. Their licensing for public redistribution needs an owner decision. Some of these files hold local machine paths. They are protected test data, so this PR does not change them.
  • master has no branch protection or ruleset.

Cargo.toml already declares MIT. NOTICE now points to the file. Refs #98
CLAUDE.md (AGENTS.md links to it): replace the private-visibility rule with the public-repository rules. PROVENANCE.md: remove the private mark and the private report path. Refs #98
README: status, working and missing features, targets, requirements, build, test, usage, layout, attribution, license, contributing. The reference, test, mode and C0 sections move unchanged to docs/TESTING.md, the host services and events to docs/EMBEDDING.md. The per-commit baseline table is removed; Git history keeps it. Refs #98
@github-actions

Copy link
Copy Markdown

MiniMax-M3.1-Flash QA

Findings

[P2] Remove the stale “PRIVATE” label from PROVENANCE.md

In the source-repository table:

| source repository | `Ascendance3D/X_ITE_R` (PRIVATE) on 2026-10-25, under the owner decision ... |

The surrounding prose was updated to remove “PRIVATE,” but the table still labels the source repository as private. This contradicts the repository’s newly public status and CLAUDE.md’s instruction not to expose private infrastructure details.

Please update the table entry to remove (PRIVATE), for example:

| source repository | `Ascendance3D/X_ITE_R` on 2026-10-25, under the owner decision `CODEMIRROR_EXTRACTION_OPTION_A_AUTHORIZED` |

Also search the final repository for other stale privacy wording such as “private repository,” “PRIVATE,” or instructions to keep the repository private.

No other clear correctness issues were evident in the supplied diff. The public-visibility guidance, license/NOTICE updates, documentation split, and CI artifact ignores are generally consistent.

@DJAscendance

Copy link
Copy Markdown
Member Author

MiniMax P2 ("PRIVATE" label in PROVENANCE.md): not applicable. At a513240, rg -n -i private over PROVENANCE.md, README.md, NOTICE, docs/TESTING.md and docs/EMBEDDING.md finds no match. The quoted table row does not exist; the only "(PRIVATE)" was in the opening paragraph, and this PR removes it. CLAUDE.md has one match, in the new rule "Do not commit … private infrastructure details". Exact-head CI: test and Review pass at a513240.

@DJAscendance
DJAscendance merged commit 32f3cca into master Oct 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: prepare the repository for public contributors

1 participant