Create an extensible build process to enable additional tooling
Open
Nobody has claimed this yet.
dev: enhancement 🛠️✨
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
Build process
- Must be usable on Windows and Linux
- Probably Python
- Familiar
- Subprocess works with non-Python software calls
- System calls are mostly or entirely covered by Python built-ins, cross-platform
- Start with what we already do: mkdocs only
- Consider concurrency, some steps may be time-consuming (link checking)
Enabled Tooling
- SCSS to define CSS more compactly and expressively
- Mkdocs Plugin?
- External Node package via NPM?
- Link checking
- Time-consuming
Workflow Manager
- Nice to have, not needed at the start.
- Find something lightweight and expressive (https://github.com/apache/hamilton)
- We probably don't need a lot of cross-job interaction beyond ensuring we follow a well-defined DAG and use concurrency where possible
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
No files, tests, or current build entry point are named. Start by locating how the existing MkDocs-only build is run, then review the cross-platform Python, SCSS, link-checking, and concurrency requirements. Done would mean an agreed extensible build process that works on Windows and Linux, with MkDocs as the initial tooling scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100