The topics in this section describe how you can contribute to this documentation. For information about contributing only code to the Angular framework, see Contributing to Angular.
Angular, an open source project, depends on its community, especially when it comes to the documentation. The more the community contributes to the documentation, the better the documentation becomes. Input from you helps both new and experienced Angular developers.
You must have a GitHub account to propose a minor change or review and edit the documentation.
You can propose minor changes to a documentation topic without downloading any software. Choose the pencil icon at the top of the page, to the right of the topic title to enter your suggestion.
This section describes how to make larger contributions to the documentation.
The following steps set up your local computer to contribute documentation content.
Sign into your account on GitHub. If you don't have an account on GitHub, create a new account before you continue.
In your browser, navigate to https://github.com/angular/angular.
In your browser, fork the angular/angular
repo into your GitHub account.
On the computer that you want to edit, clone your fork of the angular
repo.
In the angular/aio
directory of your cloned repo, locally build and view the documentation.
Run the following commands. To learn more, see Angular documentation project.
yarn
yarn setup
yarn build
yarn start
NOTE: If you have any errors or issues with your yarn install, just re-run the yarn
command.
In your browser, navigate to http://localhost:4200
Review your local build of the Angular framework documentation.
After you can see your local build of the Angular framework documentation on your own system, you are ready to review and edit it. The following sections help you with the next steps.
The following steps prepare you to edit the Angular documentation successfully:
Keep Angular content up-to-date by reviewing topics for accuracy.
Update search keywordsHelp Angular developers by improving the search keywords for existing topics.
Update content through GitHubLearn how to make documentation changes through the GitHub UI.
Review the syntax and styles used within the Angular documentation set.
Angular localization guidelinesLearn about the guidelines for localizing Angular documentation.
© 2010–2022 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/guide/contributors-guide-overview