Skip to content

docs(readme): accurate description, validate command, DLA links (stacked on #76) - #77

Merged
simongonzalezdc merged 3 commits into
mainfrom
docs/readme-audit-fixes
Oct 9, 2026
Merged

simongonzalezdc merged 3 commits into
mainfrom
docs/readme-audit-fixes

Conversation

@simongonzalezdc

Copy link
Copy Markdown
Member

README audit fixes (docs-only). Stacked on #76 (base branch fix/devarch-0.4.1-readiness) so it doesn't conflict with #76's README edits; GitHub will retarget this to main once #76 merges.

  • Wrong product description fixed: TL;DR and the generated "What is DevArch Framework?" block called it a "development architecture framework and method". Rewritten from the README's own intro (local git repository archaeology).
  • devarch validate described as "Validate project configuration"; it validates the generated history HTML (matches the CLI help and Prepare DevArch 0.4.1: bind derived evidence and disable unsafe legacy paths #76's readiness note).
  • Removed the duplicated Dev Learning Archaeologist callout; updated its links to simongonzalezdc/dev-learning-archaeologist (the old KyaniteLabs URL only redirects).
  • Forgejo link labeled "(private, maintainers only)"; issue/PR guidance points to GitHub.

License (Apache-2.0, approved by Simon): already handled in #76 (README badge + License section + setup.py license/classifier → Apache-2.0, matching LICENSE). There's no pyproject.toml. No further license change is needed in this PR.

@simongonzalezdc
simongonzalezdc deleted the branch main October 9, 2026 17:19
@simongonzalezdc
simongonzalezdc changed the base branch from fix/devarch-0.4.1-readiness to main October 9, 2026 17:20
@simongonzalezdc
simongonzalezdc merged commit 2de7940 into main Oct 9, 2026
10 checks passed
@simongonzalezdc
simongonzalezdc deleted the docs/readme-audit-fixes branch October 9, 2026 17:31
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