← Back to issue list

docs: odd Explanation tree/page rendering

View original Github issue

Metadata

Project
craft-providers
Number
#894
Type
issue
State
open
Author
steinbro
Labels
Type: Bug
Created
Updated
Closed
—

Current evaluation

Docs bug: the "Failure to properly execute commands that depend on network access" section lives inline in docs/explanation/index.rst with a _network-error label but is not in the toctree, so it renders in the page body yet not in the sidebar.

Suggested action: keep open

Reason: Root cause is pinpointed in the source: docs/explanation/index.rst declares the section directly in the index body (line 17-19) while the `.. toctree::` at line 12 lists only `Cryptographic technology <cryptography>`, so Sphinx renders it as an orphaned body section with no sidebar entry — exactly the 'both in and not in' symptom reported, with a live repro URL. The issue is labelled Type: Bug and filed by maintainer steinbro, so it is triaged and valid; it remains unfixed at HEAD (grep confirms `_network-error:` is still absent from any toctree), so it should stay open. Minor doc/UX impact, but the fix is well-scoped (move the section into its own file and add it to the toctree).

Evaluated by: mr-cal-bot

Impact: 22 Quick Win: 13 Complexity: 28 Confidence: 88 Actionability: 82

Issue body

### Bug Description The "Failure to properly execute commands that depend on network access" page is strangely both in and not in the Explanation section, both as rendered in the sidebar and what's shown in the main body when selected. This feels like a minor syntax error somewhere in the docs structure. <img width="2732" height="2047" alt="Image" src="https://github.com/user-attachments/assets/3c8509cc-ae3b-44d9-b38e-252bdc0a1cd8" />. ### To Reproduce Visit: https://canonical-craft-providers.readthedocs-hosted.com/en/latest/explanation/#failure-to-properly-execute-commands-that-depend-on-network-access ### part yaml ```shell ``` ### Relevant log output ```shell N/A ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 22
Quick Win: 13
Complexity: 28
Confidence: 88
Actionability: 82
keep open Docs bug: the "Failure to properly execute commands that depend on network access" section lives inline in docs/explanation/index.rst with a _network-error label but is not in the toctree, so it renders in the page body yet not in the sidebar.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 19
Complexity: 22
Confidence: 84
Actionability: 80
keep open A maintainer-filed documentation bug reports inconsistent Explanation sidebar and body placement for a network-access failure page; the underlying Sphinx structure remains unidentified.
qwen3.6-35b-a3b-mtp-q6
Impact: 20
Quick Win: 19
Staleness: 65
Complexity: 5
Confidence: 75
Support Request: 0
needs triage Documentation rendering bug: network error section appears in page but not sidebar due to missing toctree entry
qwen/qwen3.6-35b-a3b
Staleness: 65
Complexity: 15
Confidence: 85
Support Request: 5
keep open Documentation rendering issue where a specific explanation page appears incorrectly in the sidebar and main body, likely due to a minor syntax error in the docs structure. Currently unaddressed after ~3 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 60
Complexity: 15
Confidence: 80
Support Request: 5
keep open Documentation rendering issue where a specific explanation page appears incorrectly in the sidebar and main body, likely due to a minor syntax or configuration error in the docs structure.

Update history

No update history recorded yet.

Related work

  • Caused By: craft-providers#185 (confidence 70%)

    Commit 20d154b 'docs: explanation on network issues (#185)' introduced the section that still sits outside the toctree;1e16ba5 (#296) later restructured the docs layout without moving it.

  • Related To: craft-providers#587 (confidence 35%)

    Commit 34cab41 'chore: point to correct readthedocs docs (#587)' is the only other commit touching the _network-error label; likely only a URL/link adjustment, not a structural fix.

Related issues

No related issues found above the similarity threshold.