RunestoneInteractive / RunestoneInteractive/rs
Display sha of commit book was built from somewhere.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 69
- Forks
- 117
- Avg merge
- 6d 4h
- Merged PRs (30d)
- 24
Description
When debugging issues with a book it is nice to know exactly what sources the book was built from. It would be great if the hash of the git commit the book was built from was displayed somewhere.
One possibility is to display it on the Author Tools page. Another possibility would be to actually embed it somewhere in the book itself so when browsing the book you can check what version it was built from. (This would also help debug caching issues where some people are seeing an old version of the book because some server hasn't been updated or whatever.)
Ideally, we could have both.
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 locating the Author Tools page and the book build entry point in the TypeScript repository. Determine where the source commit hash can be obtained and where build metadata or displayed book content is assembled. Done means the relevant interface, the book, or both show the commit hash used for the build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100