On 30th of September, I had a meeting with Jet Mante and James Scholz with regards to my Google's Season Of Docs project.
Unfortunately, Prof. Myers was unable to join the meeting to due a conflict in his schedule. I was able to successfully resolve almost all of my doubts in the weekly meeting. Jet suggested a few minor changes in the Plugins page of the documentation, which're as follows:-
- It might be nice to add the graphic back to the overview section.
- I think the numbering of subsections helps as it is difficult to see any difference between the installation and using synbiohub title font.
- I think it makes sense to just link out to the installation section for the heading 'using synbiohub'. The common problems and adding plugins to the admin panel could be added to that section.
- For the standalone methods:flask servers:anaconda section you have not made some of the code red (it is just formatted as text) 5. this is also the case under the python windows os section and the javascript node.js section
- under the naming convention section you replaced "<" and ">" with '"' for the second line, this is odd as quotations are generally not used to signal placeholders
- In the naming convention section there is a lack of enter between the final example and the paragraph that starts "The same name is then used"
- I think the way recieves and return are structured should possibly be more standard throughout status, evaluate, and run under visual, submit and download
- making clear that for evaluate and run endpoints what is recieved is the body of an http post request is a good idea
- I think the general 'indentation' of headings should be changed.
I was able to successfully complete all the above tasks except one, i.e "Adding a graphic back to the overview section".
I'll be having a small conversation with Jet over the Email, so as to understand this point to a better extent.
This week's meeting won't be taking place since, my mentors will be taking part in COMBINE2020.
I was also to take part in COMBINE2020, but since my college announced surprise Mid Semester examinations, hence I was unable to, though I'll try to watch the recordings, if they're available.
I would also like to thank my mentors for understanding the situation regarding my examinations and allocating less work!
Top comments (1)
Season of Docs, Meeting-6 focuses on enhancing documentation through collaboration between open-source projects and technical writers. Participants share insights, progress updates, and best practices to improve user guides and technical content. This initiative fosters community engagement and knowledge sharing. For more details and resources related to Season of Docs, visit zelajet.com for comprehensive information!