Product

Platform Overview

Neenja reads a `.neenja/` documents folder and renders recognized documentation, technical plans, and task trees as a local or static project reader.

productoverviewworkflow

What it is

Neenja combines three things:

  • a .neenja/ document folder
  • agent skills that create and maintain project documents
  • a reader UI that parses recognized project files and exposes them as navigable project documentation

The reader currently recognizes these document filenames:

  • .neenja/documentation.md for concept documentation
  • .neenja/project-plan.md for a technical architecture and implementation plan
  • .neenja/task-tree.yaml for a decomposed implementation task tree

The document type is determined by filename. Unknown files in the folder are ignored by the reader.

Typical usage

  1. Run npx skills add MesonWarrior/Neenja --all.
  2. Use /neenja-init at the start of a project when the user gives the brief and wants a technical plan plus task tree candidate for review.
  3. Use /neenja-bootstrap once so an agent can generate .neenja/documentation.md from the actual repository.
  4. Run neenja serve while working locally.
  5. Run neenja build when you need a static reader bundle.

After the skills are installed, neenja-sync should be applied by the model automatically on later tasks so documentation stays current.

Rendering model

  • serve reads .neenja/ by default and shows the full private documentation set, including private documentation concepts, project plans, and task trees.
  • build reads the same folder and emits only public documentation concepts by default, unless --private is passed.
  • Public mode, used by build by default and by serve --public, renders only documentation documents with public concepts. Project plans and task trees are private developer documents and are omitted from public routes and static output.
  • Private mode, used by serve by default and by build --private, includes project-plan pages and task-tree pages whenever those files exist.
  • The root route uses documentation only when it has visible concepts. If documentation is empty and a project plan is in the loaded collection, the project plan becomes the default root document.
  • The header navbar switches between recognized document types.
  • Documentation and project-plan pages use a sidebar. Task-tree pages use the whole viewport as the graph workspace.