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

Aperta
#953 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia dalla pagina Collapse FAQs collegata, quindi confrontala con gli esempi della documentazione di riferimento della collapse API e con il cheat sheet della libreria. Esegui la build della documentazione Sphinx per identificare le pagine orfane, rimuovi le pagine obsolete individuate dalla revisione e conferma che la build venga completata senza avvisi relativi a pagine orfane.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NCAS-CMS/cf-python

Tutte le issue di NCAS-CMS/cf-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.