Angular's Documentation can be easily updated by the following process:
Identify a small change in the documentation. Click the friendly blue
Improve this doc
button at the top right of the doc page to fork the repository in-place and make a quick
change on the fly.
Or
- Identify a larger fix in the documentation.
- To minimize duplication, go to the issue queue for
Milestone:Docs Only
.
- Comment on an issue to let others know what you're working on, or create a new issue if your
work doesn't fit within the scope of any of the existing doc fix projects.
- Checkout a new git branch and work on a change. Make a commit of the format
"docs(<scope of changes>): < description of changes in the imperative not beginning in
capital letter or ending in period and less than 100 characters >". See the
Git Commit Guidelines for more information.
-
Then
build and test
the documentation using "grunt test". Be sure you haven't accidentally introduced any layout
or formatting issues.
- Push your branch to GitHub with "git push origin <branch-name>"
- If changes are suggested, make the updates, re-run the test suite. Then rebase and force push
to your GitHub repository.
- Last, be proud that you have improved the documentation for all Angular developers!
See the
Contributing Guidelines for more information.