AlexsLemonade / AlexsLemonade/refinebio-py
Github Documentation + Github Actions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Problem:
Generating Github Pages documentation is not well documented and the process is awkward.
Proposed Solution:
I think we can keep the existing makefile etc for local dev but for github pages we should be regenerated on release and possibly updating the doc/config.py to match the release version / tag automatically.
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 reviewing the existing Makefile and doc/config.py, then inspect how GitHub Pages documentation is currently generated and how releases are handled. Done means the GitHub Pages process is documented, regeneration is tied to releases, and the documentation version or tag updates appropriately without disrupting local development.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100