Create user manual
Totktonada opened this issue · comments
Alexander Turenko commented
I think the project documentation should have three parts:
- API documentation (reference).
- Where: ldoc is good for that.
- Problems: now we have parts of a user manual and internal functions descriptions here.
- User manual.
- Where: README, possibly than splitted into separate files.
- Problems: we almost have no such documentation.
- Hacking and internals.
- Where: separate set of markdown files?
- Problems: where we have such descriptions they are are in ldoc comments, but they should not be part of the API documentation.
Alexander Turenko commented
I'm going to archive the repository. I'll proceed as follows:
- Mark all open pull requests with the
archived
label and close. - Mark all open issues with
archived
andwontfix
labels and close. - Archive the repository.
Consider the following projects: