diff --git a/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json b/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json index cf59fb371..70f7a8b45 100644 --- a/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json +++ b/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json @@ -151,17 +151,21 @@ }, { "style": "Title", - "text": "Switch to the Develop Branch", - "updated": 1613809817136 + "text": "Switch to the Develop Branch and Update Before You Start", + "updated": 1613811592905 }, { "style": "Note", "text": "All contributions must be submitted to the Develop branch. Make sure you update to the latest version in Develop and that everything you are submitting works properly in that version." }, + { + "style": "Subtitle", + "text": "Switch to Develop", + "updated": 1613811609773 + }, { "style": "Text", - "text": "To switch to the develop branch:", - "updated": 1613810052223 + "text": "To switch to the develop branch:" }, { "style": "List", @@ -180,6 +184,22 @@ "text": "Follow the instructions to close and restart the app.", "updated": 1613810110150 }, + { + "style": "Subtitle", + "text": "Update to the Latest Version" + }, + { + "style": "List", + "text": "Run the App Update Command" + }, + { + "style": "Json", + "text": "app.update" + }, + { + "style": "List", + "text": "Close the app and restart." + }, { "style": "Block", "text": "Dummy", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-003-how-to-contribute-to-the-docs.json b/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-003-how-to-contribute-to-the-docs.json index d020cfa9f..e910c919a 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-003-how-to-contribute-to-the-docs.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-003-how-to-contribute-to-the-docs.json @@ -8,13 +8,86 @@ }, "paragraphs": [ { - "style": "Include", - "text": "Superalgos->Concept->Reusable Snippets->Contributions Reminder", - "updated": 1613731423038 + "style": "Title", + "text": "Coordination", + "updated": 1613819062207 }, { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode. Then you can use doscs.save to save your changes and app.contribute to send it to the main repository." + "text": "Join the Docs Group to coordinate efforts with other contributors:", + "updated": 1613819084738 + }, + { + "style": "Link", + "text": "Docs Group->https://t.me/superalgosdocs" + }, + { + "style": "Text", + "text": "Please, introduce yourself and get up to speed with the group currently doing the work. The main coordination efforts involve planning the documentation of new functionality or discussing which sections of the Docs need a revision.", + "updated": 1613819203043 + }, + { + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Contributions Reminder" + }, + { + "style": "Title", + "text": "Learn How the Docs Work", + "updated": 1613811876102 + }, + { + "style": "Text", + "text": "You probably have an idea of how the Docs work from using the app and doing the first few tutorials. If you intend to contribute the occasional small fixes on existing pages, you probably know enough to start contributing!", + "updated": 1613819282818 + }, + { + "style": "Text", + "text": "However, if you wish to get involved in documenting new functionality, reorganizing topics, arranging books, and so on, you should read The Docs Explained book.", + "updated": 1613819297682 + }, + { + "style": "Title", + "text": "Logistics and Best Practice", + "updated": 1613817330818 + }, + { + "style": "Text", + "text": "There may be several people contributing to the Docs at any point in time. To minimize the occurrence of conflicts at the time of merging your contributions into the Superalgos repository, the following practices are highly recommended.", + "updated": 1613819314231 + }, + { + "style": "List", + "text": "Update your app frequently so that you incorporate recent changes other users may have submitted.", + "updated": 1613817514502 + }, + { + "style": "List", + "text": "Do not keep changes locally for too long. Split your work and submit your contributions every day.", + "updated": 1613817561886 + }, + { + "style": "Text", + "text": "When you run the App Contribute Command, a Pull Request is created at your fork. The Superalgos repo maintainers will look into your submission and determine if it may be merged as is, or if the work requires any adjustments.", + "updated": 1613818674004 + }, + { + "style": "List", + "text": "Keep track of your contributions until they are merged.", + "updated": 1613818739120 + }, + { + "style": "List", + "text": "Stay responsive if there is any feedback or requests from maintainers.", + "updated": 1613818758881 + }, + { + "style": "List", + "text": "Be attentive to emails you may get from GitHub.com", + "updated": 1613819348463 + }, + { + "style": "Text", + "text": "" } ] } \ No newline at end of file