Our system to collaboratively write our manuscript has been deployed! 🎉

[pedrohbraga]

General announcement

Hi!

We now have a Github repository (this one!) that has a framework for us to collaboratively write our manuscript! 🎉

Its features are:

1. A continuous integration, automated system for writing our academic manuscript via GitHub. This system is based on Manubot, which automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub.
2. An HTML and a PDF version of the manuscript that is always up-to-date with the latest commits that are made to the main repository.
3. A Discussions section, where we can openly discuss this project! Anything discussion goes there, ranging from open-ended discussions, - such as the suggestion of relevant literature, suggestion and discussion of subjects or concepts -, or calls for help or collaboration on specific subjects, such as Q&A!
4. An Issues section, where we should open and resolve problems, suggest major modifications to the manuscript or the manuscript structure.
5. A Pull requests section, where everyone submits their changes to the manuscript for other contributors to review and merge them to the main manuscript!
6. An automated Projects section (testing), which is supposed to automatically track and show us the status of pending issues, pull requests and other milestones for the project.

"I would like to contribute! Where do I start?"

You should begin by accessing the README.md file to understand the structure of the repository!

To contribute with writing, you should read the CONTRIBUTING.md guidelines!

Do you need a little overview of the fundamentals of Git and Github? Go to the Getting started section from the USAGE.md file!

Would you like to understand how text formatting (e.g. citations, tables, figures) is done? Jump directly to the Manubot usage guidelines section from the USAGE.md file!

Suggestions

Feel free to Open a New Discussion or Create a New Issue if you would like to suggest or provide changes to this system!

Do not hesitate to ask for help!

Happy writing for us!!!