openmainframeproject / openmainframeproject/software-discovery-tool
Adding Documentation for software-discovery-tool
@pratham1729 is already working on this.
Since May 22, 2023.
- Dominant language
- JavaScript
- Stars
- 41
- Forks
- 50
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 3
Description
As I discussed with @pleia2, we should have a documentation page for the software-discovery-tool, like a readthedocs page, something along the lines of https://dagger-docs.readthedocs.io/en/latest/?badge=latest, this is a project in which I had contributed majorly on the documentation.
I'll be using sphinx (https://www.sphinx-doc.org/en/master/) to create the documentation
and ReadTheDocs (https://readthedocs.org/) to host it.
@pleia2 @arshPratap kindly look into it and assign this issue to me as I would like to work on it.
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.
Assessment
This issue has not been assessed yet.