#3630 closed defect (fixed)

Add instructions about updating docs

Reported by: sajith Owned by: sajith
Priority: normal Milestone: Contributor Experience
Component: documentation Version: n/a
Keywords: Cc:
Launchpad Bug:

Description

docs/README.txt should have some notes on updating documentation and previewing it locally.

Change History (5)

comment:1 Changed at 2021-03-16T23:25:56Z by exarkun

is docs/README.txt a good place for this information? What about someplace _inside_ the documentation? Are folks more likely to find one of these or the other?

A big advantage of putting this _in_ the documentation is that then it can be rst, it shows up on readthedocs (someday), it's in the index, etc.

comment:2 Changed at 2021-03-17T18:31:46Z by sajith

My guess is that folks are less likely to find this information if we move this inside the manual, at least right now, because contents of the manual are not very discoverable in its current shape. We should re-organize the manual a little bit before moving this content there. I have filed issue #3636 to address this.

I created this ticket merely to make docs/README.txt a little more useful than it is now.

comment:3 Changed at 2021-03-17T18:48:22Z by sajith

Also created #3639, about adding some content about editing the manual to the manual itself.

comment:4 Changed at 2021-03-30T19:05:24Z by meejah

  • Milestone changed from undecided to Contributor Experience

comment:5 Changed at 2021-03-31T19:50:08Z by GitHub <noreply@…>

  • Resolution set to fixed
  • Status changed from new to closed

In b133d0e/trunk:

Merge pull request #997 from sajith/3630.update-docs-readme

Update notes about reading/writing docs

Fixes: ticket:3630

Note: See TracTickets for help on using tickets.