Get started content provides an entry point into using GitHub products and features. This section should contain only the minimum essential information a user needs before they move on to concepts and how-tos. We do this to be concise, and also so it doesn't seem complicated just to get started with a feature.
Get started considerations
Get started is a set of articles which should be easy and fast to scan. It should contain fewer than 5 articles, and ideally only two:
- Quickstart
- About [PRODUCT] (or “What is [PRODUCT]”)
The one exception to this may be with available plans and billing information, where such information is required to use the product or feature.
For more information on quickstart content, see クイック スタート コンテンツ タイプ.
In particular, articles with this information do not belong in Get started:
- Articles that fall under the how-to content type.
- Set up or sign up steps: these are also how-tos. They document how to do something in the UI.
- Content that is useful for getting started with a particular feature but not the whole product area. This kind of content more properly belongs in Concepts.
- Best practices, generally. Users new to a feature lack the context necessary to make the most of these.