Contributing to the Wiki

Contributing to the Wiki

This wiki is a git repository (APPN_GenricFileStorage.wiki) alongside the code repo. Edits can be made via the GitHub web UI or by cloning the wiki repo locally.

Editing locally

git clone https://github.com/ArdenB/APPN_GenricFileStorage.wiki.git
cd APPN_GenricFileStorage.wiki
# edit .md files
git add -A && git commit -m "docs: <short summary>" && git push

Page categories (Diátaxis-inspired)

Every page should fit one of four purposes. Pick one before writing:

Category	Purpose	Example
Guide	Step-by-step tutorial to learn something	ProjectBuilder
How-to	Task-oriented recipe for a specific goal	"How to add a new node"
Reference	Lookup tables, schemas, naming conventions	Folder-Structure, Key-Files
Explanation	Background / design rationale	"Why hierarchical naming?"

If a page mixes categories, split it.

Page template

Copy the block below when creating a new page:

# <Page Title>

> One-sentence summary of what this page covers.

## Overview

2–4 sentences giving the reader enough context to decide if this is the right page.

## <Main content sections>

...

## Examples

Minimal, copy-pasteable examples.

## See also

- [[Related-Page-1]]
- [[Related-Page-2]]

Naming conventions

• File names use Title-Case-With-Hyphens.md (GitHub renders them as "Title Case With Hyphens").
• Reserved files:
  • Home.md — wiki landing page and hub.
  • _Sidebar.md — persistent left-hand navigation on every page.
  • _Footer.md — persistent footer on every page.
• Prefer updating an existing page over creating a near-duplicate.

Linking

• Use [[Page-Name]] wiki links for internal pages (renders as "Page Name").
• Use full URLs only for external links or for linking to files inside the code repo (e.g. LICENSE, source files).
• When referencing code, link to the file on main rather than pasting code that will go stale.

Style

• Start each page with a title (# ...) and a one-line summary.
• Use fenced code blocks with a language tag (```bash, ```python, ```yaml).
• Keep tables narrow; split into multiple tables if they get unwieldy.
• Prefer short paragraphs and bullet lists over walls of text.
• Don't duplicate content from README.md or code docstrings — link to them.

When to update the Changelog

Add a dated entry to Changelog when:

• The folder hierarchy changes.
• NodeSummary.yaml schema changes.
• A new top-level wiki page is added or an existing one is renamed.

Sidebar and footer

_Sidebar.md and _Footer.md are shown on every page. Update _Sidebar.md whenever you add, remove, or rename a top-level page so navigation stays in sync.

See also

• Home
• Diátaxis documentation framework