Skip to content

docs: add docs/README.md index of the documents under docs/ (#24) #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hsinatfootprintai merged 1 commit into from
Oct 23, 2026
Merged

docs: add docs/README.md index of the documents under docs/ (#24) #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Docs

Index of the documents under `docs/`, grouped by directory. The PRD comes
first because the design is sized to it.

## Product

- [PRD: Touchstone](product/touchstone.md) — paste a vendor's URL, get an evidence-graded CVE report.

## Architecture

- [Design: Touchstone](architecture/touchstone.md) — one Go module, one binary (`touchstone`), one container: a modular monolith where each evidence source is a package behind an interface, and a pure pipeline core merges their output into a `ScanReport`.
Loading