Skip to content

docs: add kun-init 4-file documentation structure#65

Open
Soarecos wants to merge 1 commit into
mainfrom
KUNAI-8
Open

docs: add kun-init 4-file documentation structure#65
Soarecos wants to merge 1 commit into
mainfrom
KUNAI-8

Conversation

@Soarecos

@Soarecos Soarecos commented Jul 2, 2026

Copy link
Copy Markdown

Description

The objective of this PR is to introduce the kun-init 4-file documentation structure, giving humans and agents a clear, non-duplicated set of entry points.

Issues

  • KUNAI-8

Details

Establishes strict ownership across four documentation files:

  • README.md — what the library is, install, and usage. Moved the "Running Tests" section into CONTRIBUTING.md and renamed the Contribute heading to Contributing.
  • AGENTS.md — short steering doc for agents: domain, code layout, quality gates, and hard constraints, pointing to the deep docs.
  • CONTRIBUTING.md — reconciled to own all development workflow: dev setup, testing, quality gates, and the pull request process. Fixed the PSR-2 link (blob/master -> blob/main).
  • CLAUDE.md — references AGENTS.md.

No section is duplicated across files. Quality gates and scripts point to composer.json rather than being pinned inline.

@Soarecos Soarecos requested a review from a team as a code owner July 2, 2026 17:02
@sonarqubecloud

sonarqubecloud Bot commented Jul 2, 2026

Copy link
Copy Markdown

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