Update docs to be explicit about supported platforms
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 10
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 5
Description
# 📚 Documentation Request
## Clarification
Our docs have been written with the assumption that ANTS will only ever be run on Linux. If we make our packages available on conda-forge, users may make the assumption that we support other platforms. We should be be explicit that we only support Linux.
This means both the built docs and the README visible in GitHub should both be updated.
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
Start by reviewing the GitHub README and the source used to generate the built documentation, looking for existing platform-support wording. Update both documentation outputs to state that ANTS supports Linux only, then verify the README and built docs say the same thing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- linux, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100