SoarGroup / SoarGroup/SoarGroup.github.io
Generate Soar programming reference from Doxygen comments and host here
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 16
- Forks
- 7
- Avg merge
- 5d 18h
- Merged PRs (30d)
- 1
Description
Particularly an SML programming reference would be very helpful, since SWIG ignores Doxygen comments, and Python/Java, etc. developers are mostly flying blind. Whenever I need to understand something about the SML API, I search through Soar's C++ code for the original definition and read the comments there.
Contributor guide
No contributing guide indexed for this repository
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
The issue points to Soar's C++ definitions and their Doxygen comments, with SWIG currently omitting those comments. Start by locating the relevant API definitions and how this website hosts documentation. Done means an SML programming reference is generated from the comments and hosted here for Python and Java developers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100