Improve documentation

Open
#2 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the existing data-frame reference and system manual, then inspect how declt handles statistics doc strings and comments. Clarify whether the work covers the API reference, the system manual, or both; done should be an agreed scope with the relevant documentation improvements published.

Written by the indexing model from the issue text.

Description

This issue is to track two potential improvements in documentation:

  • API reference
  • System manual

API Reference
Lisp-Stat uses declt to generate reference documentation from doc strings and output HTML, PDF, epub, etc. For example see the reference for data-frame. This doesn't work too well for statistics because either:

  1. There is no doc string
  2. The doc string is in a comment preceding the function.

System Manual
It seems that the majority of new users are not from the Common Lisp community and often they're not well versed in statistics either. If we look at other statistical computing systems, like Python, Julia or R, they have robust documentation, with plenty of examples. See the data frame system manual for an example.

Dominant language
Common Lisp
Stars
5
Forks
4
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.