Any member of the community is welcome to suggest changes to Frontity's official documentation at any time. Frontity's documentation can be found at:
| Docs Site | Repository | Description |
|---|---|---|
| docs.frontity.org | https://github.com/frontity/docs | Introduction, concepts and guides |
| api.frontity.org | https://github.com/frontity/api-reference | API Reference |
| tutorial.frontity.org | https://github.com/frontity/step-by-step-tutorial | Step by Step guide |
Any and all help is very much appreciated!
The following describes how to contribute to the Frontity documentation.
If you're stuck at any point, don't hesitate to use Frontity's Community Forum to ask for help or make your suggestions.
This document contains all the required information and links to resources needed to contribute to the Frontity documentation:
- Code of Conduct - our Code of Conduct
- Platform - how do we get the online documentation site from these repository docs
- Documentation Format - syntax of the documentation docs in this repository
- Reporting Issues - guidance on how to report an issue or provide feedback on the Frontity documentation
- Contributions Workfows - a collection of workflows available for contributing
- Edit on GitHub - the recommended way to suggest small changes
- Fork & Edit on GitHub - the recommended way to suggest several changes (in several files)
- Fork, Local Edit & Push - the recommended way if you're already familiar with git
Frontity's framework provide a Code of Conduct to make clear the behavior we expect from contributors and maintainers alike. The people behind Frontity is committed to providing a welcoming and supportive environment and kindly request that you participate in these values also.
Frontity's Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.
Frontity uses gitbook to generate the documentation site which is connected to our docs repositories
| Docs Site | Repository | Description |
|---|---|---|
| docs.frontity.org | https://github.com/frontity/docs | Introduction, concepts and guides |
| api.frontity.org | https://github.com/frontity/api-reference | API Reference |
| tutorial.frontity.org | https://github.com/frontity/step-by-step-tutorial | Step by Step guide |
Every time the master branch of each repo is updated the whole documentation site is rebuild
This docs repositories are the "source of truth" for Frontity's documentation and any suggested changes are managed through Pull Requests (to its master branch).
The documents in the different docs repositories use Markdown syntax to add format and structure to the texts.
If you want to know more about Markdown then take a look at:
These Markdown documents are used by gitbook to generate the final HTML you can see in our documentation site.
If you have found a bug or a spelling mistake, or if you consider that information is missing or that improvements can be made, or if you find anything related to the Frontity documentation that you feel is an issue that should be reported, you can:
- Directly create a Pull Request with your suggested changes using one of the Contributions Worflows as explained below
- Use our Community Forum to tell us about it
The maintainers of the framework will review your suggestions and will take any actions necessary to improve our documentation taking your feedback into consideration.
Want to do a code contribution that may require an update of the docs? Follow our code releases workflow
To suggest changes in Frontity's documentation you'll need a GitHub account (so create it if you don't have already one)
There are several workflows you can use to suggest changes. All of them finish with the creation of a Pull Request.
If you want to know more about Pull Requests you can take a look at:
Your changes will not be visible right away, the maintainers of the framework will first review them and then merge them if the suggested changes are approved. So you don't need to worry about breaking anything!
Here you have the most important workflows you can use to suggest changes in Frontity's documentation:
• Edit on Github 📝
This workflow is recommended for minor changes in just one file and for those who have little or no experience with git or github. With this workflow you can edit documentation directly online in your browser.
Learn more about this workflow here.
This workflow is recommended for changes in several files and for those who have some experience with git or github With this workflow you can also edit documentation directly online in your browser.
Learn more about this workflow here.
• Fork, Local Edit & Push 📝📝📝
If you are familiar with Git, you can use the Fork, Local Edit & Push workflow.
This, in fact, is the preferred method for all but very minor changes.
If you've previously contributed to other projects on GitHub via pull requests, you should already be familiar with this workflow.
Learn more about this workflow here.
For minor changes, or if you're new to GitHub, we suggest that you use the
Edit on Githubworkflow, because it's a quick and easy way to make changes.
If you have knowledge of Git and/or your proposed changes are more extensive then we recommend that you use
Fork, Local Edit & Push.