doc: update the documentation for the doc framework

Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>

doc/README.md

@@ -13,15 +13,15 @@ GitHub provides a basic rendering of the documentation as well, but important fe
 LXD's documentation is built with [Sphinx](https://www.sphinx-doc.org/en/master/index.html) and hosted on [Read the Docs](https://about.readthedocs.com/). <!-- wokeignore:rule=master -->
 
 It is written in [Markdown](https://commonmark.org/) with [MyST](https://myst-parser.readthedocs.io/) extensions.
-For syntax help and guidelines, see the [MyST style guide](https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide-myst/). <!-- and the [documentation cheat sheet](https://documentation.ubuntu.com/lxd/en/latest/doc-cheat-sheet-myst/) ([source](https://raw.githubusercontent.com/canonical/lxd/main/doc/doc-cheat-sheet-myst.md)). -->
+For syntax help and guidelines, see the [MyST style guide](https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide-myst/) and the [documentation cheat sheet](https://documentation.ubuntu.com/lxd/en/latest/doc-cheat-sheet-myst/) ([source](https://raw.githubusercontent.com/canonical/lxd/main/doc/doc-cheat-sheet-myst.md)).
 
 For structuring, the documentation uses the [Diátaxis](https://diataxis.fr/) approach.
 
 ### Build the documentation
 
 To build the documentation, run `make doc` from the root directory of the repository.
-This command installs the required tools and renders the output to the `doc/html/` directory.
+This command installs the required tools and renders the output to the `doc/_build/` directory.
 To update the documentation for changed files only (without re-installing the tools), run `make doc-incremental`.
 
 Before opening a pull request, make sure that the documentation builds without any warnings (warnings are treated as errors).
-To preview the documentation locally, run `make doc-serve` and go to [`http://localhost:8001`](http://localhost:8001) to view the rendered documentation.
+To preview the documentation locally, run `make doc-serve` and go to [`http://localhost:8000`](http://localhost:8000) to view the rendered documentation.

doc/contributing.md

@@ -88,7 +88,7 @@ GitHub runs automatic checks on the documentation to verify the spelling, the va
 
 You can (and should!) run these tests locally as well with the following commands:
 
-- Check the spelling: `make doc-spellcheck`
+- Check the spelling: `make doc-spellcheck` (or `make doc-spelling` to first build the documentation and then check it)
 - Check the validity of links: `make doc-linkcheck`
 - Check the Markdown formatting: `make doc-lint`
 - Check for inclusive language: `make doc-woke`

doc/custom_conf.py

@@ -156,7 +156,7 @@
 linkcheck_ignore = [
     'https://127.0.0.1:8443/1.0',
     'https://web.libera.chat/#lxd',
-    'http://localhost:8001',
+    'http://localhost:8000',
     r'/lxd/en/latest/api/.*',
     r'/api/.*',
     r'https://maas\.io/docs/.*'