Overview

Polestar is open source, and most of it is plain text: the guides, the toolchain (Node, with no npm dependencies) and the addon's Lua. A wrong step fixed in a .guide file reaches every player in the next release.

Start with#

• Contributing: the ways to help, a good wrong-step report, fixing a guide, setup, checks, branches, and how a pull request is reviewed.
• Building from source: clone, build the reference data and the addon, and run the checks.
• From source to game: how a .guide file becomes the steps in the guide window.
• Map and glossary: where each question is answered, how data flows, and the words the docs use.

How it fits together#

• Architecture: the contract between the addon's modules, the compiled guide data, the toolchain and the tests, one page per module.
• The addon, file by file, the toolchain and the tests: the repository's own guides to its three main folders.
• The suite: the modules and their scope, the data layer and the in-game data addons.
• Route simulation: the world model, the character model, the search and its results.
• Design system: who the windows are for, and the colour, type, layout and component tokens.
• Agent workflows: the checklists a contributor's AI agent follows, for contributing, triage and guide fixes.
• Releasing: what ships, and the steps for feature releases, patches and release candidates.