How to Update the Official Documentation_

Our API is constantly changing and evolving so it is important to keep our official documentation up to date. Here are the steps for updating the docs.

• Navigate to the Assembly/docs repository in your browser.

  • Reach out to Andrew if you need access to that repository.

• Clone the repository to your machine using git clone <https://github.com/AssemblyAI/assemblyai-api-spec.git\>.

• Make sure that you are in the main directory.

• Do git pull to make sure your local repository is up to date.

• Create a new branch using the format <yourName/name-of-branch>

• Make the necessary changes. To see your changes locally, you can run this code in your IDE terminal: fern docs dev

• Make a commit for those changes with git add . and git commit -m “<your commit message>”, phrasing the message as if you are completing this sentence: “This commit will…”. In addition, make sure to preface the commit messages with “docs:”, “fix:”, or “cookbook:” before the message. Refer to other branches and commit messages for reference.

• Push your changes with git push origin <your-branch-name>.

• At the Assembly/docs repository in your browser, click on the “Pull requests” tab.

• Click “New pull request”. Give it a title, a brief description, and select Mart as the reviewer.