search

frmscoe / docs

This is the main directory for all project documentation files.
Apache License 2.0
23 stars 3 forks source link

Contribution guide update required for setting up dev environment #14

Open Sandy-at-Tazama opened 3 months ago

Sandy-at-Tazama commented 3 months ago

https://github.com/frmscoe/docs/blob/main/Guides/full-service-full-stack-docker-tazama.md and https://github.com/frmscoe/Full-Stack-Docker-Tazama/readme.md have links to Tazama-Contribution-Guide.md – section 3.2 . It wasn’t clear where I should stop. I followed the section titled “requirements” checking against the pre-requisites in full-service-full-stack-docker-tazama.md. I did note that the requirements section started with node.js which was not listed as a pre-requisite in full-service-full-stack-docker-tazama.md. I did it anyway, but it did make we wonder whether I was supposed to. The requirements section in Tazama-Contribution-Guide.md – section 3.2 is followed by a section on Microprocessor set up instructions. Was I supposed to stop here? I did notice that the instructions in full-service-full-stack-docker-tazama.md in the prerequisite section also included a link to the same point viz A. Preparation (step 1: setting up GitHub token locally)

The integration and flow between these links could be improved