NCAS-CMS / NCAS-CMS/cf-python

Docs: remove old orphaned pages e.g. 'Collapse FAQs'

Open
#953 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

From searching on 'collapse' and related terms for some user support I've come across a 'secret page' in the docs: Collapse FAQs. It's a small page listing two example usage cases of grouped collapses, which are already essentially covered by the collapse API reference page examples, and the overall library cheat sheet.

So we should just remove it. We should also review the docs in case there are other outdated pages - sphinx builds can alert us to any orphans etc. so those can be auto-detected.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Collapse FAQs page, then compare it with the collapse API reference examples and the library cheat sheet. Run the Sphinx documentation build to identify orphaned pages, remove outdated pages identified by the review, and confirm the build completes without orphan warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.