XBSL user guide
The map of the guide: installation, checking, scaffolding, the servers and the platform data.
The guide is split by task. The README is the short tour. Each page below covers one part of the toolkit in depth.
| Page | What is there |
|---|---|
| Quick start | the package, the language data from your distribution, the language of the output |
| Checking sources | the flags of a run, what the deeper rules rely on, the baseline, CI |
| Rules | the full list of checks, with severities and scope |
| Metadata scaffolding | objects, attributes, routes and forms through the engine; code templates |
| Comments in yaml | where a note in an element description survives the visual editor, and the rules that check it |
| Servers and plugins | the LSP server, the MCP server, the web panel, plugins of your own |
| Platform data | the generated datasets, the documentation index, the diff between two versions |
| Translating a project | rewriting the sources into English spellings: the dictionary, the coverage, the CI check |
| Commands | every command and flag, generated from the tool itself |
| VS Code extension | the editor built on the same engine: diagnostics, the metadata tree, deploy |
| Visual designer | the form panel, the palette, the properties panel |
| Documentation panel | the platform help inside the editor: contents, search, the page for a symbol |