Skip to content

docs: rewrite README, add CONTRIBUTING with AI disclosure, clean repo root - #390

Merged
David-Noble-at-work merged 2 commits into
developfrom
readme-root-cleanup
Aug 12, 2026
Merged

David-Noble-at-work merged 2 commits into
developfrom
readme-root-cleanup

Conversation

@David-Noble-at-work

Copy link
Copy Markdown
Contributor

Summary

  • README rewritten (licensing-readme-plan v0.2 §5.3): onboarding/roles
    lead, iceberg example, honest binary naming, real install paths,
    cross-platform incl. PowerShell provider, registry link, Apache-2.0,
    devlore.org
  • CONTRIBUTING.md added: Apache-2.0 §5 + DCO; AI disclosure required
    (Assisted-by: trailer), acknowledged-never-credited, undisclosed use
    is a permanent ban
  • Root triage: 4 stale files deleted, 4 sketches → docs/sketches/,
    ARCHITECTURE-STATUS → docs/architecture/STATUS.md, coverage.out removed
  • go-style-guidelines.md mirrored from noblefactor-ops with its
    copyright-header rule corrected to Apache-2.0
  • Apache sweep completed: 127 generated *.gen.go files + the seven
    go.render templates that stamp them + two extensionless configs
    (missed by PR chore(license): relicense to Apache-2.0, retract SSPL-era tags #389; templates were invisible to the linter)

First push to develop since the Release workflow was re-enabled — the
merge mints the first Apache-2.0 tagged release.

Assisted-by: Claude

Test plan

  • go build ./... passes; gen-package tests pass post-header-fix
  • star lint copyright: all 793 files correct
  • Test-GuideFrontmatter.sh passes with the new guide
  • Full-repo SSPL grep: only go.mod retract comment + linter fixture
  • CI quality-gate (markdownlint not available locally)

David Noble added 2 commits August 12, 2026 16:51
Complete the sweep PR #389 missed: 127 tracked *.gen.go files, whose
headers come from the go.render templates in
star/extensions/.../templates/*.gen.go.template (skipped by the copyright
linter due to the .template extension). Fix the seven templates so
regeneration emits Apache-2.0, sweep the generated files to match, and
correct the two extensionless stragglers (.githooks/pre-commit,
.pre-commit-config.yaml). Remaining SSPL mentions are intentional: the
go.mod retract rationale and a linter test fixture.

Also lands the root-document triage (staged earlier by script): stale
snapshots deleted (GITHUB-ISSUES, CODE-CONSOLIDATION-ANALYSIS,
TEST_BREAKS, commit_msg.txt), sketches moved to docs/sketches/,
ARCHITECTURE-STATUS to docs/architecture/STATUS.md.

Assisted-by: Claude
Signed-off-by: David Noble <[email protected]>
README rewritten per licensing-readme-plan v0.2 §5.3: DevLore-first
framing (onboarding and roles above the fold, the Docker iceberg second),
honest current-binary naming with the devlore unification noted, install
paths that exist today, the genuine cross-platform statement including
the PowerShell provider, the registry relationship, Apache-2.0 stated
once, devlore.org links.

CONTRIBUTING.md added: Apache-2.0 §5 inbound terms with DCO sign-off,
and the AI-disclosure policy — assistance is welcome, must be announced
via Assisted-by trailer, is acknowledged never credited, and undisclosed
use is a permanent ban. go-style-guidelines.md mirrored from
noblefactor-ops (header rule corrected to Apache-2.0) so public
contributors can read the rules star lint enforces.

Assisted-by: Claude
Signed-off-by: David Noble <[email protected]>
@David-Noble-at-work
David-Noble-at-work merged commit 030a879 into develop Aug 12, 2026
7 of 8 checks passed
@David-Noble-at-work
David-Noble-at-work deleted the readme-root-cleanup branch August 13, 2026 00:00
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.

1 participant