ScuroNeko/Laniakea

REPOSITORY / ScuroNeko/Laniakea

Wiki

KNOWLEDGE REPOSITORY

Table of Contents

AGENTS.md

Scope
Purpose
Writing goals
Content rules
Page structure
Maintenance rules
Commit discipline

AGENTS.md

Scope

These instructions apply only to the wiki repository in this directory.

Purpose

The wiki is the structured documentation layer for Laniakea. It should complement the main README.md rather than duplicate it line-by-line.

Writing goals

Optimize for navigation and fast orientation.
Prefer short pages with strong links over giant all-in-one documents.
Explain design intent, API boundaries, defaults, and migration-relevant behavior.
Keep examples practical and consistent with the current codebase.
Sort information by importance, necessity, and expected popularity of use.
Put setup and first-use material before advanced extension points.
Apply that ordering consistently on Home.md, when adding new pages, and inside each page when listing methods, types, structures, or workflows.
Documentation should be as detailed as needed to remove ambiguity.
Add examples whenever they materially improve understanding.

Content rules

Reflect the current public API from the main repository.
When behavior is version-sensitive, mention the relevant version explicitly.
Prefer English page titles and stable page names.
Keep Home.md concise and link-focused.
Avoid restating low-value godoc verbatim unless the wiki adds context.

Page structure

Start each page with a one-paragraph summary.
Then list the most important concepts or decisions first.
Use short sections and flat bullet lists.
Link related pages whenever a topic crosses page boundaries.
Within a page, explain the most necessary and most frequently used APIs before less common or advanced ones.
Prefer complete explanations over minimal notes when the topic has real usage nuance.

Maintenance rules

When adding a new page, update Home.md if the page is user-relevant.
Prefer editing existing pages over creating overlapping pages.
Keep terminology aligned with the code and README.
Wiki-only changes do not require updating the main repository CHANGELOG.md.

Commit discipline

Wiki commit messages should follow the same repository rule:
1. one short summary line;
2. up to three additional high-signal lines.

Start here

Runtime and Architecture

Interaction and Telegram API

Practical Guides

Maintenance