{"id":41055,"date":"2020-07-02T10:14:06","date_gmt":"2020-07-02T10:14:06","guid":{"rendered":"http:\/\/icloud.pe\/blog\/?guid=7ab0bf99d95023bf7321028dc9a9a060"},"modified":"2020-07-02T10:14:06","modified_gmt":"2020-07-02T10:14:06","slug":"developers-welcome-major-overhaul-to-githubs-support-documentation","status":"publish","type":"post","link":"https:\/\/icloud.pe\/blog\/developers-welcome-major-overhaul-to-githubs-support-documentation\/","title":{"rendered":"Developers welcome major overhaul to GitHub’s support documentation"},"content":{"rendered":"


\n Keumars Afifi-Sabet<\/a><\/span>
\n <\/span><\/p>\n

\n
\n
2 Jul, 2020<\/span><\/div>\n<\/p><\/div>\n<\/div>\n

\n<\/a><\/p>\n

\n

GitHub<\/a>\u00a0has merged its two developer support sites into a single unified documentation hub to support users and integrators, offering a single repository of guidance and resources.<\/span><\/p>\n

The platform,\u00a0docs.github.com<\/a>, merges the now-defunct help.github.com site and the widely-used developer.github.com, giving users the capacity to search across all of GitHub\u2019s product content in a single place.<\/span><\/p>\n

Previously, users seeking support would navigate either to the help platform, which was primarily curated for beginners, or the development platform, targeting advanced users, with GitHub addressing these two communities separately.<\/span><\/p>\n

\u201cAs our product offerings have evolved, we decided to create a single place where everyone can find the information they need, whether you\u2019re a new developer signing up for your GitHub account or a seasoned developer in the community,\u201d said the platform\u2019s\u00a0product documentation team manager Jenn Leaver<\/a>.<\/span><\/p>\n

\u201cThis new site combines the product content that was on help.github.com and developer.github.com into a unified experience. With docs.github.com, you\u2019re able to search across all of GitHub\u2019s product content in one place.\u201d<\/span><\/p>\n

\n

Users can explore docs.github.com by product, with support documents divided into branches, from GraphQL API to GitHub Actions, or they can use the search function to find something specific. The platform also lists a collection of getting started articles, as well as the most popular entries.<\/span><\/p>\n

Leaver added this launch was the first step in creating an advisory platform on which users can discover new tools and methods, with further improvements coming in future. Language support, for example, will soon be expanded beyond\u00a0its existing\u00a0support for English, Japanese, Simplified Chinese, Brazilian Portuguese and Spanish.<\/span><\/p>\n

The news has been welcomed\u00a0by\u00a0developers on social media, with others also calling for the concept to be extended to private repositories. Startup\u00a0CTO<\/a>\u00a0and advisor Tom Jowitt, for example, called on GitHub to roll out an organisation-wide private documentation hub.<\/span><\/p>\n

<\/p>\n

\n
\n

This is nice and all that but I'd love org-wide private documentation hubs that you could use to generate guides, API docs, etc. Having a single source of up-to-date information that wasn't a bunch of static sites, READMEs and confluence pages for each repo would be a huge asset. https:\/\/t.co\/YwCfJHGhPQ<\/a><\/p>\n

— Tom Jowitt (@tommyjowitt) July 2, 2020<\/a><\/p>\n<\/blockquote>\n