Skip to content

SRGSSR/rts-development-guidelines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RTS Development Guidelines

This repository provides guidelines aimed at enhancing the quality of your project's documentation and promoting best practices. These guidelines cover a range of topics, from crafting a comprehensive README to selecting an appropriate license.

To access the guidelines, please visit: RTS Development Guidelines.

How to Contribute

We welcome contributions from everyone. The site is hosted on GitHub pages and is powered by docsify, served from the public folder in this repository.

Here's a brief overview of the project structure:

  • public: This directory serves as the homepage for the docsify site.
  • public/_sidebar.md: This markdown file renders the sidebar of the page. Add links to your guidelines here.
  • public/guides/: This directory contains the guideline documents, written in markdown.

To create a new guide, simply add a file under public/guides and include a link to it in the _sidebar.md file.

Tip

To test the site simply open public/index.html on your project.

Please adhere to our Contribution Guidelines when making a contribution.

Feel free to open issues, submit pull requests, or share your ideas.

License

For more information, please refer to the LICENSE file.