Documentation

Purpose

The Documentation area is Allye's knowledge space. It organizes pages in a tree, maintains Markdown content, supports team filtering, and publishes material so that people and agents can find the right context without relying on old conversations.

Prerequisites

• Be authenticated and have documentation view permission.
• Select a team to browse its document tree.
• Have create, edit, or delete permission for mutations.
• To edit documents owned by another team, have documentation management permission.

Key concepts

Document and folder

The tree can contain root and child documents. The types available in the interface include Folder, Page, Guide, Tutorial, and API Doc. A folder organizes navigation; a page or guide contains knowledge that can be read and maintained.

Content and metadata

A document can have a title, description, emoji, language, category, tags, keywords, and content. The editor supports Markdown, links, images, tasks, tables, and Mermaid blocks.

States

The filters in the application recognize draft, review, published, and archived. A new document starts as draft. Publishing makes it explicit that the content is ready for consumption; archiving removes the document from the active flow without necessarily deleting its usage history.

Create a document

1. Open Documentation.
2. Select the team that should own the document.
3. Select Create at the root or the add action inside a folder.
4. Enter a title, description, emoji, and type.
5. Confirm the creation.
6. Open the document and write the content in Markdown.
7. Fill in tags, keywords, category, and language when they improve discovery.
8. Save the changes.

When creating a child, the document inherits the context of the selected folder. Use titles that express the subject rather than titles such as “Notes” or “New document.”

Organize the tree

1. Select a document in the tree.
2. Drag it above or below a sibling to reorder it.
3. Drag it into a folder to make that folder its new parent.
4. Observe the optimistic preview of the position.
5. Wait for confirmation before closing or starting another move.

The tree is filtered by the selected team. The selector may show all teams available for reading, but create, edit, and delete operations remain subject to the owning team and permissions.

Edit and publish

1. Open the document from the tree, recent list, or detail page.
2. Edit the title, description, content, and properties as needed.
3. Use the content preview to review links and formatting.
4. When the material is ready, select Publish.
5. To remove a document from the active flow, select Archive.
6. To remove a document, confirm the deletion knowing that it cannot be undone through the interface.

The detail page shows a breadcrumb for returning to the tree and keeps the same editor and access rules as the explorer view.

Duplicate content

In the explorer view, the duplicate action creates a new document with the original document's title, content, properties, and position, starting as draft. Give the copy a new title before confirming so it is not confused with the source.

Search and follow documents

• Use search to find documents by title and indexed content.
• Use status and type filters on mobile.
• Check Recent Documents to return quickly to recently accessed content.
• Use the tree to understand the relationship between a guide and its chapters.
• Select the correct team before interpreting that a document does not exist.

For agents

When reading documentation to answer a question or make a change:

1. Confirm the organization and active team.
2. Start at the root or folder that represents the request's domain.
3. Read the parent document before assuming that a child is self-contained.
4. Check the status: draft may contain a proposal, while published generally represents material in use.
5. Cite the document title and tree position in the result so a person can find the source again.
6. When updating, preserve the existing structure and metadata; change only the necessary section.
7. Do not automatically publish a change that still needs human review.

Product documentation should explain intent, rules, and usage. Implementation details, internal contracts, and sensitive information should remain outside pages intended for the workspace's public audience.

Current states and limitations

Current state: CRUD, hierarchical trees, search, team filters, Markdown editing, movement, publishing, archiving, recent documents, and access analytics are represented in the application.

• Versioning is still partial. The interface provides actions and a versions area, but version creation and persisted history are not complete in every view.
• In the explorer view, duplication is performed as a new creation with copied content. On the detail page, the action indicates that it is not yet available.
• An empty list can mean that the selected team has no documents or that the query could not load data; check the context and try again before concluding that there are none.
• Published does not mean immutable: users with edit permission can still change the content.
• Access is filtered by the user's own team or management permission; viewing documents from other teams does not grant the right to edit them.

Next steps

• Structure a tree by domain, product, or process.
• Record lasting decisions in Memories.
• Use Skills for operational instructions that agents should follow.
• Consult Access and teams to resolve edit and publishing permissions.