Documentation

Knowledge

Knowledge

Knowledge is documentation, the left-most panel Chat can search. It seeds Ideas and receives write-back after Complete. The walk between those ends is Ideas (ideation until ready) → Work (commitments) → Complete (proof).

Areas

The left rail lists areas this project named. There are no default shelves. Click + Add to name one. Rename the selected area from the header. Removing an area does not delete documents, they move to Unfiled.

Agents cannot mint areas. They may file into an existing area or Unfiled.

Needs a home

Unfiled is the only product-owned pile. Uploads land here until someone files them. Drag a document onto an area, or use Move.

Documentation

The right side lists that area’s documents. The human title is the row. Click anywhere on a row to open it. Upload adds a file to the current area (or Unfiled). Hub Upload accepts files up to 25 MB.

When the library has no documents yet, Documentation is a drop target: Upload a document to seed Knowledge. Drop a file, or use Upload. Develop Add to Knowledge opens Knowledge and that picker.

A connected agent can upload a file too (up to 8 MB). Larger files stay on this Upload button. Markdown notes, “what we now know”, are not files: they land from Complete Add this to documentation, or from the agent as a note, not as an upload.

Extract ideas pulls ideas from a document into Ideas, with a chip back to the source. Remove takes a document out of Knowledge.

After files land in Unfiled and the project still has no named areas, chips suggest names from those files. Confirm creates the areas you picked. Hub never mints an area on its own.

Read

Document text wraps naturally, with headings and nested lists preserved.

Based on says which Goals and specs a document describes. For a switched-on spec, it can also name one requirement and the revision the document was written for; the requirement sits under its spec. Click a title to open that Goal or spec. Remove takes a row off the list, and Undo puts it back.

A document nobody has linked yet reads Basis unknown. Hub does not guess a basis for you.

Suggested from this document lists Goals, specs and requirements the text mentions, by identifier, by title, or by quoting a requirement. Add makes a suggestion part of the basis. Nothing is saved until you press it. A connected agent can pass a basis when it writes or uploads a document. Complete Add this to documentation offers the accepted spec or Goal as the basis; untick it to leave it out.

Potentially outdated

When a requirement a document is Based on changes, the document reads Potentially outdated at the top of its drawer and on its row in the list. The note says what changed, and Open with the spec's title opens the spec that changed. The same happens when a requirement is retired, or its Goal or spec is gone. A change an agent proposed does not count until a person approves it.

Hub also drafts a Proposed amendment. Where the document quotes the old requirement text, the amendment replaces it with the approved text. Where it does not, the amendment adds a note under Changed in Hub since this was written, for you to place. The document does not change until a person decides:

  • Approve writes the amendment into the document and updates what the document is based on. The document is then no longer marked.
  • Edit opens the amended text so you can change it first. Then press Approve with your changes.
  • Dismiss needs a reason. The document stays marked until what it is based on is current. Dismissing a draft does not make the document right.

If the requirement or the document changes again before you decide, the old amendment is not applied. Hub says so and shows the current one.

Only a person can approve or dismiss. A connected agent can read the mark and the amendment with rinkata_knowledge_read, as outdated and amendment.

A PDF is read-only, so it is marked but gets no amendment. Re-upload it to replace the file.

Edit

Text-like docs (markdown, plain text, JSON, YAML) have Edit in the drawer header, next to ✕. PDFs stay read-only, re-upload to replace the file.

Markdown is the document. Write is a markdown editor (headings, B, I, bullets, numbered lists, Insert image). Paste or drop a PNG, JPEG, or WebP, or use the toolbar, Hub stores the image and inserts it as markdown. Click a list tool on an empty line to start an item; Enter starts the next one; Enter on an empty item leaves the list. Preview shows the same rendering as the saved document, switching tabs does not change what you wrote.

JSON, YAML, and plain text edit as raw text so structure stays intact. They do not gain Insert image. A .md file still gets Write / Preview even if the upload landed as plain text.

Save and Cancel (or ⌘↵ / Escape). Nothing autosaves. Leaving with unsaved changes, ✕, Escape, the backdrop, Help, or another drawer, asks Discard or Keep editing. Empty Save is refused. The card title stays the document’s name, a heading in the body does not rename it.

After Complete

When you Accept a spec on Complete, Add this to documentation can record what deployed. Summarize under the Documentation field drafts it from the spec and its finished tickets. It does not pick the area or save, edit the draft, then Add or Update. Skip leaves Accept in place.

That write-back is a markdown note, not a file upload.

QA

QA is an area for interactive test checklists, usually a Tests document named after the Goal, generated when you Accept on Complete. Open one and mark each check Pass, , , or Fail. Clear resets the marks; they last for this open only.

A Fail can become an Idea: Create Idea from bug seeds Ideas with the check name and steps. Retry if that write misses.

Chat

Chat is the dock on the left of every panel, not a box in the top bar. It searches these documents and cites them under Documents. If nothing is uploaded yet, upload a file first. History, ticket rows, and chip permalinks live on Chat.

A document is a record of what was true when it was written. Hub holds what is true now. So an answer shows both:

  • Approved requirements in Hub lists each requirement of a switched-on spec the question is about, as a person last approved it. A change that is waiting for approval is marked Proposed and Not approved yet. It is not a commitment until a person approves it.
  • Each cited document shows the date it was added and what it is Based on, or Basis unknown.
  • Potentially outdated means a requirement the document was written for has since changed, was retired, or its Goal or spec is gone. The note says what changed, and the answer itself ends by saying so. Use the approved requirement, then update the document.

A connected agent gets the same facts from rinkata_knowledge_ask, as commitments and sources.

See also