docs: drop specification and plan links from the README
This commit is contained in:
parent
c853fff995
commit
baf00f1079
3
.gitignore
vendored
3
.gitignore
vendored
@ -20,3 +20,6 @@ report/
|
|||||||
deploy/*.env
|
deploy/*.env
|
||||||
# private TLS keys and certificates
|
# private TLS keys and certificates
|
||||||
deploy/tls/
|
deploy/tls/
|
||||||
|
# design/planning documents kept locally, not tracked
|
||||||
|
docs/SPECIFICATION.md
|
||||||
|
docs/implementation/
|
||||||
|
|||||||
@ -3,10 +3,10 @@
|
|||||||
A minimalist web UI that researches a Confluence Data Center instance with a
|
A minimalist web UI that researches a Confluence Data Center instance with a
|
||||||
[pi](https://github.com/earendil-works/pi) agent running in a fresh, network-less
|
[pi](https://github.com/earendil-works/pi) agent running in a fresh, network-less
|
||||||
rootless Docker container per query, and returns a cited Markdown answer plus
|
rootless Docker container per query, and returns a cited Markdown answer plus
|
||||||
optional files the agent produced. The design is in
|
optional files the agent produced. The integration results are in
|
||||||
[docs/SPECIFICATION.md](docs/SPECIFICATION.md); the wire contracts in
|
[docs/INTEGRATION_REPORT.md](docs/INTEGRATION_REPORT.md); each component
|
||||||
[docs/implementation/CONTRACTS.md](docs/implementation/CONTRACTS.md); the
|
documents its own interface in `agent/README.md`, `backend/README.md` and
|
||||||
integration results in [docs/INTEGRATION_REPORT.md](docs/INTEGRATION_REPORT.md).
|
`frontend/README.md`.
|
||||||
|
|
||||||
The repository also contains the original standalone
|
The repository also contains the original standalone
|
||||||
[Confluence crawler](#standalone-crawler), which is unchanged.
|
[Confluence crawler](#standalone-crawler), which is unchanged.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user