mgechev / mgechev/angular2-style-guide
consider using GitBook
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1.2k
- Forks
- 94
- PR merge metrics
- No merged PRs in 30d
Description
In my experience, creating these super huge Readme files will go south sooner or later... hard to maintain, hard to refactor etc...
Consider using GitBook, all in all [Dan Abramov Redux guide](http://redux.js.org/index.html) is really good example how things should look like IMHO.
thx
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
Review the repository's README and the linked Redux guide to understand the current documentation structure and the proposed GitBook approach. Determine whether the documentation should move to GitBook, what content would need restructuring, and how completion would be verified; the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 18/100