PRODUCT REFERENCE

Maintain this documentation

Help is an editable set of local HTML pages. Classification, order, and global search metadata are controlled by one validated catalog.

Start here · Contract identities

Source layout

SourceResponsibility
catalog.jsonClassification, page order, stable page identifiers, filenames, summaries, and search keywords.
help.cssShared typography, color, tables, code examples, callouts, and page spacing.
*.htmlOne complete, focused document per topic.
HELP.mdMaintainer instructions at the source-package root.

Edit an existing page

Edit the topic's HTML file in pycforge/ide/resources/help/. Keep {{HELP_STYLESHEET}} inside its <style> element and use {{APPLICATION_VERSION}} where the installed application version belongs. Links between pages use catalogued filenames and optional anchors, such as diagnostics.html#result-state.

Add and classify a page

  1. Create a lowercase, hyphen-separated HTML filename in the Help directory.
  2. Use the complete structure of an existing page, including UTF-8 metadata, shared stylesheet placeholder, one clear title, and useful section IDs.
  3. Add one entry under the appropriate category in catalog.json. Provide a unique ID, title, filename, one-sentence summary, and focused search keywords.
  4. Add local cross-links from related pages when they materially improve navigation.
  5. Run the complete tests and build both distribution formats. Verify that the catalog, stylesheet, and every page are present in each artifact.

To create a new classification, add a category object with a unique ID, visible title, and at least one page. The dialog generates the left navigation from the catalog. No Python topic list needs editing.

Offline and safety contract

Documentation is self-contained and deterministic. Pages do not load network resources, scripts, frames, embedded objects, external style sheets, data URLs, or local-file URLs. The dialog opens only catalogued local page filenames and internal anchors. The loader bounds catalog, stylesheet, page, total-document, keyword, and search-result sizes.

Documentation review checklist