docs: align rag-api with the portfolio docs standard - #13
Merged
Merged
Conversation
Restructure README.md and docs/ to the shape used by inference-gateway, so the two repos read as one body of work rather than two projects that happen to share an author. README follows the fixed spine: descriptive title, capability bullets, Contents, Demo, The problem, How it works, Quickstart, Trade-offs, Results, What I'd do differently, Known gaps, Repo layout, Documentation, License. Measurements leave the opener for the Results table, since that section is scanned rather than read. Configuration and the endpoint reference move out into docs/. docs/ becomes the standard six files. DEPLOY.md is renamed DEPLOYMENT.md and gains What gets provisioned, the topology diagram, three constraints worth knowing up front, and an inline Troubleshooting list. ARCHITECTURE drops the cloud topology and its headings now mirror the README's How it works lead-ins one for one. API.md and CONVENTIONS.md are new. CONVENTIONS.md is the load-bearing addition: it records the spine, the docs layout, and this repo's accuracy guards, so the standard is enforced in-repo rather than from a gitignored checklist. The drift between these two repos happened because that file did not exist. Mermaid diagrams drop every classDef and style block so they inherit the reader's light or dark theme instead of rendering as white boxes in dark mode. The AWS topology goes from 74 lines to 19 and keeps the security group rules as edge labels, since those are what make public-subnet tasks defensible. Also correct two infrastructure comments that claimed more than the code does: nothing writes to the S3 bucket, and the VPC is multi-tier rather than three-tier.
CLAUDE.md had become a second architecture document, restating docs/ARCHITECTURE.md, docs/CONVENTIONS.md and the deployment docs, which guarantees the copies drift apart. It also opened on build-plan phases and the Project 2 relationship, neither of which helps the reader it actually has: an agent working in a fresh clone. It now does one job, matching inference-gateway's CLAUDE.md section for section: get the repo running and verify a change. What survives is the run and verify commands, the eval targets, a map of the tree, and the things that waste time on a first pass. Nothing unique was deleted. The design conventions were already in ARCHITECTURE.md, including the constraint that both sides embed with the same model and that the pgvector column dimension is pinned to match it. The naming exception and the accuracy guards were already in CONVENTIONS.md, and the AWS realities in DEPLOYMENT.md and OPERATIONS.md. The gotcha list is the part that was not written down anywhere: a native Postgres shadowing the container on :5432, /health staying green while Bedrock returns AccessDenied because the probe touches neither Bedrock nor the database, go test skipping the store without TEST_DATABASE_URL, and the two identities a fork has to change, the go.mod module path and the OIDC sub claim IDs. Request bodies in the quickstart are read off the handler structs rather than carried over, so /ingest takes text and not content.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings this repo onto the same documentation shape as
inference-gateway, so the two read as one body of work rather than two projects that happen to share an author. Two commits, docs only, no code changes.docs: align the repo with the portfolio README spine and docs layoutREADME follows the fixed spine: descriptive title, capability bullets, Contents, Demo, The problem, How it works, Quickstart, Trade-offs, Results, What I'd do differently, Known gaps, Repo layout, Documentation, License. Measurements leave the opener for the Results table, since that section is scanned rather than read.
docs/becomes the standard six files.DEPLOY.mdis renamedDEPLOYMENT.mdand gains What gets provisioned, the topology diagram, and inline troubleshooting.ARCHITECTURE.mddrops the cloud topology and its headings now mirror the README's How it works lead-ins one for one.API.mdandCONVENTIONS.mdare new.CONVENTIONS.mdis the load-bearing addition. It records the spine, the docs layout, and this repo's accuracy guards, so the standard is enforced in-repo rather than from a gitignored checklist. The drift between the two repos happened because that file did not exist.Mermaid diagrams drop every
classDefandstyleblock so they inherit the reader's light or dark theme instead of rendering as white boxes in dark mode. The AWS topology goes from 74 lines to 19 and keeps the security group rules as edge labels, since those are what make public-subnet tasks defensible.docs: cut CLAUDE.md down to getting the repo runningCLAUDE.mdhad become a second architecture document, restatingARCHITECTURE.md,CONVENTIONS.mdand the deployment docs, which guarantees the copies drift. It now does one job, matchinginference-gateway's file section for section: get the repo running and verify a change.Nothing unique was deleted. The design conventions were already in
ARCHITECTURE.md, including the constraint that both sides embed with the same model and that the pgvector column dimension is pinned to match. The naming exception and accuracy guards were already inCONVENTIONS.md.The gotcha list is the part that was not written down anywhere:
:5432/healthstaying green while Bedrock returnsAccessDenied, because the probe touches neither Bedrock nor the databasego test ./...skipping the store withoutTEST_DATABASE_URLgo.modmodule path and the OIDCsubclaim IDsVerification
go build ./...andgo vet ./...pass. Quickstart request bodies were read off the handler structs rather than carried over, which caught/ingesttakingtextand notcontent.