GitHub, the social media site that’s used by over 30 million developers worldwide, has announced that the API has been revamped to improve the quality of its documentation.
In addition to a new documentation system, GitHub’s API now allows for developers to make documentation available as a git repository on GitHub’s servers.
“We’ve made it so that documentation is always available in GitHub’s repository for anyone to review and collaborate with,” the GitHub API team writes in the blog post announcing the change.
“This includes documentation for new features and documentation that is still in the early stages of development.”
GitHub says the new documentation will allow for better collaboration between developers and users.
“For developers and new contributors, GitHub documentation will be a better way to collaborate and provide a better experience than writing boilerplate code,” the blog reads.
“Git documentation can be edited and merged with your code, and you can easily view and review changes as they’re made.
If you need help or have any questions, you can always reach out to GitHub.”
The announcement comes as GitHub has also announced a new feature to help with documentation: GitHub’s Docs for Developers.
The API also makes a lot of improvements to how documentation is formatted and presented, including a new “Docs for Developer” page that allows for a “better search and review experience for documentation.”