quine-linux/installer/anaconda-webui/vendor/docs/README-documentation.rst
Philip Peterson 255042fe8d Vendor anaconda-webui and build it into the installer image
Replaces installing a patched anaconda-webui RPM from the forge's package
registry: installer/anaconda-webui/vendor/ is upstream release 86 verbatim
(see its PROVENANCE.md), and installer/Containerfile builds it with
upstream's own `make install` in a native-platform stage, then copies the
result over stock Fedora anaconda-webui. The produced file set matches
Fedora's anaconda-webui-86-1.fc46 exactly. Edits to the installer UI now
happen in vendor/ and ship on the next `task build-installer-iso`, with no
RPM, registry or CI in between.

Also follows bootc-image-builder's rename of --bootc-installer-payload-ref
to --installer-payload-ref.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 05:56:26 -08:00

40 lines
999 B
ReStructuredText

Documentation Generation System
=================================
Overview
--------
This system automatically generates comprehensive documentation for Anaconda
Web UI. The generated documentation is ready for readthedocs.io integration and
includes complete information about the installation flow.
Usage
-----
Generate Documentation
~~~~~~~~~~~~~~~~~~~~~~~
To generate/update all documentation:
.. code-block:: bash
make docs
This generates:
- ``docs/installation-steps.rst`` - Complete installation guide including all pages and storage scenarios
Continuous Integration
----------------------
A GitHub Action (``.github/workflows/docs-check.yml``) automatically verifies that documentation stays up-to-date with code changes.
Contributing
------------
When adding new scenarios or pages:
1. Add JSDoc ``@description`` comments in page or scenario file
2. Run ``make docs`` to update documentation
CI will automatically verify that documentation stays current with code changes.