readthedocs / readthedocs/ext-theme
Build: show build step
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
We will have additional build steps soon, for pre/post builds, etc. We may want to show the explicit step names somewhere in the UI.
Two big options here:
- Show metadata like a label on each build command
- Group commands by the build step instead of just sequentially listing
Show metadata
Perhaps this is a small label or inverted label on the build command. This could overwhelm the listing though, so would need to find a minor addition here
This could lead to also wanting some balance on the UI and also showing labels for our existing commands -- for example "build", "install:default", "install:custom", etc.
Group commands by step
This might be a better UX altogether. With this method, build commands would be listed sequentially under an expanded section for each build step.
So instead of seeing the build commands listed on the build output page, the build output page would show:
- Cloning repository
- Running pre-install
- Installing dependencies
- Running post-install
- Building
- ..
Those sections could be dropped down to see the commands in each group.
We'd probably want to store the build step/substep (install:pre) on each command for easy grouping.
- Play with UI, experiment with both options
- If changing modeling separate out modeling changes
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 with the build output page and compare the two proposed UI approaches: labels on commands versus grouped commands by build step. Review the required build step/substep modeling changes, then use the issue checklist to define completion through an experiment and separated modeling work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- design, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100