Skip to content

docs: write root README and architecture guide#25

Merged
DevSecNinja merged 3 commits intomainfrom
copilot/write-readme
Apr 25, 2026
Merged

docs: write root README and architecture guide#25
DevSecNinja merged 3 commits intomainfrom
copilot/write-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 25, 2026

No root-level README.md existed for the DevSecNinja/.github repository, leaving the purpose and usage of its automation undocumented.

Adds a concise README.md with a navigation table linking to the key directories and a short development quick-start, plus a detailed docs/architecture.md covering:

  • Repository layout — annotated directory tree
  • Reusable workflows — each workflow documented with inputs table and minimal caller snippet (lint, release, config-sync, label-sync, labeler, todo-to-issue, assign-issue-to-codeowners)
  • Workflow templates — summary table of all picker templates
  • Config sync — table of auto-synced files; pointer to templates README
  • Renovate configuration — table of shared preset fragments in .renovate/
  • Design decisions — ADR index table linking into docs/design-decisions/

Copilot AI linked an issue Apr 25, 2026 that may be closed by this pull request
Agent-Logs-Url: https://github.com/DevSecNinja/.github/sessions/24cd9ac3-b66b-4eec-98fe-e98ae5a23cea

Co-authored-by: DevSecNinja <14926452+DevSecNinja@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for project README docs: write root README Apr 25, 2026
Copilot AI requested a review from DevSecNinja April 25, 2026 04:39
@DevSecNinja
Copy link
Copy Markdown
Owner

@copilot there is a lot of good info here but can you keep readme concise and move the rest to an architecture doc?

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 25, 2026

@copilot there is a lot of good info here but can you keep readme concise and move the rest to an architecture doc?

Done in 2c753f7. README.md is now a short overview table + development quick-start. All the workflow input tables, example callers, config-sync file lists, Renovate preset details, and the ADR index have been moved to the new docs/architecture.md.

Copilot AI changed the title docs: write root README docs: write root README and architecture guide Apr 25, 2026
@DevSecNinja DevSecNinja marked this pull request as ready for review April 25, 2026 07:38
@DevSecNinja DevSecNinja merged commit 25a5116 into main Apr 25, 2026
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: write readme

2 participants