NUbook monorepo
Open
Nobody has claimed this yet.
-Documentation
-Question
- Dominant language
- C++
- Stars
- 41
- Forks
- 22
- Avg merge
- 1h 48m
- Merged PRs (30d)
- 1
Description
I would like to discuss moving the NUbook source into this repo.
Some pluses:
- Much easier to update documentation at the same time as updating source
- Fewer repo's to manage/track
- API documentation generation would be local to the website it generates for. This would be much simpler than porting across generated HTML regularly, or other naive solutions I have thought of
Some minuses:
- Netlify has limited free builds - although we could probably work it out so that netlify only builds master. In that case we would have to work out some way to get the preview links for the doc pages
Please feel free to post your opinions in here
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 reading the discussion and weighing the listed benefits and drawbacks of moving the NUbook source into this repository. Define what a migration would require, including local API documentation generation, Netlify build limits, and preview links; done means the project has an agreed approach rather than an unresolved proposal.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100