featury
Back to help

Read your team docs in featury

Read your repository guides, READMEs and decisions in full without leaving featury.

Published

You can read the writing your team already keeps with the code without opening GitHub or hunting through files. featury collects your READMEs, guides, decisions and package notes in one place so you can check what the team meant in their own words.

Find documents in the Docs tab

Open your product map and go to the Docs tab. You will see your documents grouped by what they are, such as guides or decisions. Open any document to read it in full.

Links between documents stay inside the reader so you can keep reading. Other links open on GitHub at the same version you are reading, so what you see matches what the team wrote at that time.

Everyone on your workspace can browse the full list. If someone shares a link with an outside guest, the guest can open that one document.

See docs from the rest of featury

Documents show up where you already work:

  • On a feature page, look for a Documented in group. It lists the documents that describe that feature. Open one to read it, and from the reader you can see the other features that point to the same document. Learn more in Understand a feature in detail.
  • In the changes feed, an expanded delivery names the written files it updated. Select a file name to open it in the reader when it is available. Learn more in See what each release delivered.
  • In chat, answers include a quiet From the docs line under the reply. It names the documents and features the assistant actually read to answer. Select a document to open it in the reader when it is available, or on GitHub if not. Learn more in Ask about your product.

Why answers match your wording

The assistant reads your documents alongside your product map, so its answers and names for features follow what your team already wrote. If your docs change, future answers reflect the new wording.

Contact the team