microsoft / microsoft/AzureTRE
Add a `make docs` command to serve documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 235
- Forks
- 192
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 13
Description
Is your feature request related to a problem? Please describe.
I want to make it easy to run the docs site locally via a make command
Describe the solution you'd like
make docs
Describe alternatives you've considered
manually typing commands
Additional context
see also #5006
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 reading the existing documentation setup and related issue #5006, then find how the docs site is currently served locally. Add the repository command that makes make docs serve the site and verify it matches the intended local workflow.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100