pyiron / pyiron/structuretoolkit
Documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 1
- Avg merge
- 1d 28m
- Merged PRs (30d)
- 10
Description
While setting up the CI, I also created the doc/ dir, with empty files conf.py and index.rst. I did not know right away, what to do further with them. Do we have some documentation of structuretoolkit anywhere?
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
Start by inspecting the empty doc/conf.py and doc/index.rst files, then look through the repository for any existing documentation or documented structure. Clarify which project areas should be covered and what the documentation entry point should contain. Done means the documentation scope and expected contents are agreed and the doc files are no longer empty.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100