Repository template and documentation templates for Dev Portal API documentation

Overview Use this repository as a template for your own YaaS service documentation repository. Your YaaS services require documentation, published on the Dev Portal. This repository template includes the required folder structure and document type templates for your service documentation and release notes. See the Documentation SDK on the Dev Portal for more information about how to configure, register, and publish your documentation repository to the Dev Portal.

Make it easier to your project user and provide an easy to use table of contents (list of links) to navigate through the readme document.

• Installation
• Usage
• Development
• License
• Defects and Feedback
• Contribution
• [Credits[(#credits)

To make and use your own copy of this template repository:

1. Click Clone or Download > Download to ZIP.
2. Click the downloaded ZIP file and unzip it to your local machine.
3. Rename the main folder, sample-yaas-docs-repositor-master to your service name. For example: ForumAccounts
4. Copy the renamed directory and its files to the source code repository for your service.
5. Read all topics in the Documentation SDK to learn how to manage your documentation, register it in the Dev Portal, submit content for review, and publish.

Use the templates to develop your documentation in the YaaS style. See the the Dev Portal topic Tools & Resources > Documentation Guidelines for writing guidelines and Style & Standard requirements.

By using the templates in this repository, you agree to the terms and conditions of the licensing agreeement. View the LICENSE file in the root of this repository for more information.

Read the CONTRIBUTING file for information about how to contribute, provide feedback, and report defects in this repository.

❤️ from the GitHub team @ YaaS

Paste the following into the Credits section and take the YaaS.png icon with you:

[](https://yaas.io)

❤️ from the GitHub team @ YaaS Contact GitHub API Training Shop Blog About © 2017 GitHub, Inc. Terms Privacy Security Status Help