Add instructions about updating docs #3630

New Issue

sajith · 2021-03-09T19:11:58Z

sajith commented

2021-03-09 19:11:58 +00:00

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

sajith added the

labels 2021-03-09 19:11:58 +00:00

sajith added this to the undecided milestone 2021-03-09 19:11:58 +00:00

sajith self-assigned this 2021-03-09 19:11:58 +00:00

exarkun commented

2021-03-16 23:25:56 +00:00

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.

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.

sajith commented

2021-03-17 18:31:46 +00:00

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.

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.

sajith commented

2021-03-17 18:48:22 +00:00

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

meejah modified the milestone from undecided to Contributor Experience

2021-03-30 19:05:24 +00:00

GitHub <noreply@github.com> commented

2021-03-31 19:50:08 +00:00

In b133d0e/trunk:

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

Update notes about reading/writing docs

Fixes: ticket:3630

In [b133d0e/trunk](/tahoe-lafs/trac-2024-07-25/commit/b133d0e7a0d2ac11de905d5fbaf18c6ac16f8d09): ``` Merge pull request #997 from sajith/3630.update-docs-readme Update notes about reading/writing docs Fixes: ticket:3630 ```

tahoe-lafs added the

fixed

label 2021-03-31 19:50:08 +00:00

GitHub <noreply@github.com> closed this issue

2021-03-31 19:50:08 +00:00

Sign in to join this conversation.