LispCookbook / LispCookbook/cl-cookbook
Suggestion: Documentation chapter
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.1k
- Forks
- 158
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 2
Description
I think a chapter on Lisp documentation would be good to have.
Thing like:
- docstrings
- how to get documentation of lisp stuff.
- manual generation (declt, etc).
- api documentation generation (ala javadocs)
- at least mention some of the literate programming options
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing Common Lisp Cookbook chapter structure before defining the scope of a documentation chapter. Cover the listed areas—docstrings, retrieving Lisp documentation, manual and API generation, and literate programming—and consider the chapter complete when each area has useful guidance and relevant tools are identified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100