ctags
ctags copied to clipboard
Tracker for documentation for v1.0
This is a tracking issue to mark keep track of thing that need to be done to the documentation for the release of 1.0
- [x] Update the man page #657
- [x] Organize the
docsdirectory to combine the user docs and hacking docs - [ ] Add and update
old-docs/EXTENDING.htmlto the docs, which is for people who writes a parser. Maybe we need to find a good name for that. I must be added toextending.rst. - [ ] Add and update
old-docs/INSTALLtodocs/autotools.rst. This file contains a list of all the (old)configureflags and explains other things related toconfigure. - [x] Update
format.rst, which is for people who writes a tool reading tags file. Maybe create tags-format.5 from this as well - [ ] Remove
old-docscompletely after making sure everything we still need is included in our own docs.
This is not the place to discuss details about specific issues mentioned here. Use separate issues for that.
I'd also like to add that the old-doc directory should go away, so all the docs that are in there should be merged with our docs.
@cweagans you are right. I added it to the list. Thanks
I added INSTALL to the list above. I think it is still useful and should be incorporated in the docs as well, presumably added to autotools.rst. But with #676 going on, I will ask in that PR.
Sorry to be late about this.
I would like to split this into two stages: just writing and cleaning up. Milestone 0.8 is for writing. I will work on this. Milestone 0.9 is for cleaning up.