blob: aaa8a2a4ab1e42c5fd35d91cc0afaca492b4f949 [file] [log] [blame]
Googlers, please see: go/sac-guide
The site contains tutorials, references, and other
information related to the Android Open Source Project (AOSP). To report an
issue with the documentation on, please file a bug at:
To make updates to the source files themselves, follow the instructions below.
### File Location ###
The source files are stored in the platform/docs/
Android project:
The files to be edited are located in: <projroot>/docs/<language-code>/
Subdirectories exist for the tabs of with their structure
roughly (but not identically) mirroring navigation of the site. For exceptions,
the contents of the Porting tab can be found in the devices/ subdirectory,
while the contents of the Tuning tab reside in the devices/tech subdirectory.
(This is temporary while navigational changes are underway.)
## Edit Instructions ##
1. Initialize and sync the repository and download the Android source per:
2. Navigate to the docs/ project.
3. Start a temporary branch for your changes with a command resembling:
$ repo start <topic-branch-name> .
See the Repo command reference for more details:
4. Add or edit the file(s) and save your changes:
$ git add <file>
$ git commit
$ repo upload .
5. Iteratively improve the change and amend the commit:
$ git commit -a --amend
$ repo upload .
6. Once satisfied, include the changelist in a bug filed at:
Your change will be routed to the team for evaluation and