WFGY/Avatar/docs/README.md
PSBigBig + MiniPS 725eb73a68
Update README.md
2026-04-04 15:00:54 +08:00

16 KiB

📘 Docs Hub

This page is the docs hub for WFGY 5.0 Avatar.

Avatar is not only a concept surface and not only a research body.

People also need to know:

  1. how to start
  2. how to boot
  3. how to read the master correctly
  4. how to tune bounded controls
  5. how to recover after drift
  6. how to move from first use into deeper branch work

That is what this Docs layer is for.

The Docs layer exists so the project can stay usable without forcing every reader to begin from the deepest research page or the heaviest packed-master section.

It is the operational entry layer of the Avatar branch.


Why this layer exists

The Docs layer answers practical questions like:

  1. how do I enter Avatar
  2. which commands should I use
  3. how should I read the master file
  4. how do I tune the current branch
  5. how do I recover after drift or thinning
  6. where should I go next after startup

That is different from what the other layers do.

The Research layer answers deeper structural questions like:

  1. what counts as execution
  2. what counts as route law
  3. what counts as runtime carry
  4. why structured imperfection matters
  5. what happens before public emission
  6. how matrix accountability and audit burden work

The Eval layer answers pressure questions like:

  1. what breaks under hostile reading
  2. what remains stable under real use
  3. what behavior should or should not receive credit
  4. how multilingual status is being stated honestly

So the Docs layer is where operation becomes legible.

It does not replace the deeper body.
It makes the deeper body usable.


🧭 How to use this hub

Use this hub in one of five ways.

1. I want to start quickly

Start here if your main question is:

  1. what is Avatar
  2. how do I boot it
  3. what should I type first

Read in this order:

  1. Quickstart
  2. ⌨️ Boot Commands

This is the best route for first-time entry.


2. I want to understand how to read the master file

Start here if your main question is:

  1. where do I begin
  2. what order should I read different sections in
  3. how do I avoid getting lost in a large one-file system
  4. how does reading order change for article-grade tasks

Read:

  1. 📖 How to Read the Avatar Master File

This is the best route when your problem is not usage only, but lawful reading.


3. I want to tune the current branch

Start here if your main question is:

  1. which knobs matter
  2. what should be tuned first
  3. how do I compare profiles safely
  4. how do I diagnose too-flat, too-clean, too-generic, or too-aggressive behavior

Read:

  1. 🍳 Parameter Tuning Cookbook
  2. 🛠️ Avatar Tuning Workflow

This is the best route for bounded calibration and branch steering.


4. I want to recover a persona after drift

Start here if your main question is:

  1. what does avatar++ do
  2. when should I use avatar++ reload
  3. what is the difference between recovery and re-booting
  4. how do I tell if recovery actually worked

Read:

  1. 🔧 Persona Recovery Operations
  2. ⌨️ Boot Commands

This is the best route when continuity weakened after article, analysis, rewrite, search, or tool pressure.


5. I want to go deeper after Docs

Start here if your main question is no longer “how do I use it,” but instead:

  1. what is actually happening underneath
  2. how does execution work
  3. what is runtime law
  4. what is selector law
  5. how is the packed master structured

Go to:

  1. 🔬 Research Hub
  2. 🧪 Eval Hub

Docs gets you into the branch.
Research and Eval tell you what that branch is actually doing and whether it survives pressure.


🧱 What belongs in the Docs layer

The Docs layer is where operational guidance lives.

Typical Docs-layer questions include:

  1. how do I start
  2. how do I boot a persona
  3. how do I avoid false-trigger mistakes
  4. how do I read the master file correctly
  5. how do I tune the current controls
  6. how do I recover after drift
  7. where do I go when I need more than startup help

This layer should stay clear, practical, and route-aware.

It should not try to restate the entire research body.
It should not try to replace evaluation pressure.
It should not pretend a few instructions equal the whole system.

That restraint is what keeps Docs useful.


🧠 Current docs surfaces

The current Docs layer is organized into five major surfaces.

1. Startup surface

These pages help the reader begin.

  1. Quickstart
  2. ⌨️ Boot Commands

Use these when the question is:

  1. how do I start
  2. what do I type
  3. what are the valid command families
  4. how do I enter without guesswork

2. Reading surface

This page helps the reader approach the packed master correctly.

  1. 📖 How to Read the Avatar Master File

Use this when the question is:

  1. where should I begin reading
  2. what reading order should different reader types use
  3. how does article-mode reading differ from casual reading
  4. how do I avoid flattening the file into one giant prompt

3. Tuning surface

These pages help the reader steer bounded controls without turning tuning into random knob superstition.

  1. 🍳 Parameter Tuning Cookbook
  2. 🛠️ Avatar Tuning Workflow

Use these when the question is:

  1. which family should I tune first
  2. how do I compare baseline, standard, and strong
  3. how do I tune without damaging lawful floors
  4. how do I move from diagnosis to bounded comparison

4. Recovery surface

This page helps the reader restore continuity after drift, thinning, or over-cleaning.

  1. 🔧 Persona Recovery Operations

Use this when the question is:

  1. when should I use avatar++
  2. when should I use avatar++ reload
  3. what does avatar release actually do
  4. how do I know whether recovery was real or only cosmetic

5. Cross-layer routing surface

This hub itself is part of the operational routing layer.

  1. 📘 Docs Hub

Use this when the question is:

  1. what Docs page should I open next
  2. where should I go after startup
  3. when should I jump from Docs into Research or Eval

🪜 Suggested docs paths

Path A: complete newcomer path

Use this if you are starting from zero.

  1. Quickstart
  2. ⌨️ Boot Commands
  3. 📖 How to Read the Avatar Master File

This path gives you:

  1. first entry
  2. command clarity
  3. lawful reading order

Path B: startup plus recovery path

Use this if you can already start Avatar but want to recover it when it thins.

  1. ⌨️ Boot Commands
  2. 🔧 Persona Recovery Operations
  3. 📖 How to Read the Avatar Master File

This path gives you:

  1. valid boot and recovery grammar
  2. boundary between boot and recovery
  3. reading discipline after drift

Path C: tuning path

Use this if the system is working but you want to steer it more precisely.

  1. 🍳 Parameter Tuning Cookbook
  2. 🛠️ Avatar Tuning Workflow
  3. 🔧 Persona Recovery Operations

This path gives you:

  1. symptom-first tuning
  2. profile comparison discipline
  3. recovery-aware tuning

Path D: docs to research path

Use this if Docs answered the operational layer and you now want deeper understanding.

  1. 📖 How to Read the Avatar Master File
  2. 🔬 Research Hub
  3. 🗺️ Packed Master Structure Map
  4. 🔁 Dual Closed-Loop Execution Chain

This path is best when you want to move from usage to structure.


Path E: docs to eval path

Use this if Docs helped you operate the branch, but now you want to inspect whether it actually held under pressure.

  1. 📖 How to Read the Avatar Master File
  2. 🧪 Eval Hub
  3. 🧨 Blackfan Testing
  4. 🧭 Persona Behavior Checks

This path is best when you want to move from operation to inspection.


🔍 Why docs and research are different

This distinction matters.

The Docs layer answers:

  1. how to start
  2. how to read
  3. how to tune
  4. how to recover

The Research layer answers:

  1. what the packed master is
  2. what counts as execution
  3. what the selector actually selects
  4. what runtime posture actually controls
  5. why structured imperfection is a retention law
  6. how matrix accountability and blackfan audit work

So:

  1. Docs tell you how to operate
  2. Research tells you how to understand

Both matter.
They are not the same thing.


🔍 Why docs and eval are different

This distinction matters too.

The Docs layer helps you do things.

The Eval layer helps you judge whether the current branch held up under pressure.

For example:

  1. Docs explain how to recover

  2. Eval checks whether recovery actually deserves credit

  3. Docs explain how to tune

  4. Eval checks whether tuning made the branch stronger or only prettier

  5. Docs explain how to start

  6. Eval checks whether startup clarity survives real branch use

So:

  1. Docs are operational
  2. Eval is inspectable pressure

That separation keeps the branch honest.


🌱 What this layer should become over time

As Avatar grows, Docs will likely need to keep getting clearer, not just longer.

A good Docs layer should continue to do three things well:

  1. reduce startup friction
  2. reduce misreading
  3. reduce bad tuning and bad recovery habits

That means future Docs growth should stay disciplined.

New Docs pages should exist because they solve a real operational problem, not because more pages feel more complete.

This is important.

A branch can become unreadable through documentation sprawl just as easily as it can through theory sprawl.

So Docs growth should remain task-driven.


⚠️ What this hub does not claim

This hub does not claim:

  1. that all future Docs pages already exist
  2. that Docs alone are enough to understand the whole project
  3. that current Docs already replace the packed master
  4. that current Docs already cover every future branch workflow
  5. that current branch ergonomics are universally final
  6. that Docs pages remove the need for Research or Eval

This hub is a bounded operational center.

That is exactly what it should be.


🚀 Where to go next

If you want public entry

Go to Avatar Home

If you want startup

Go to Quickstart

If you want command syntax

Go to ⌨️ Boot Commands

If you want lawful reading order

Go to 📖 How to Read the Avatar Master File

If you want tuning

Go to 🍳 Parameter Tuning Cookbook

If you want recovery

Go to 🔧 Persona Recovery Operations

If you want deeper structure

Go to 🔬 Research Hub

If you want pressure and inspection

Go to 🧪 Eval Hub


Docs core

Product and layer hubs

Research

Eval

Up