search

BuildForSDG / Phenom-Frontend

Team-056 frontent solution for BuildForSDG 2020 Innovation challenge.
MIT License
0 stars 5 forks source link

Documentation tool #5

Closed onyijne closed 4 years ago

onyijne commented 4 years ago

We should document as we code A brief research on tool(s) we can use for documenting our frontend code (any framework specific tool is preferred)

What we need Any documentation tool that can serve in frontend development will do, however if you come across a framework specific documentation tool for React it would be more preferred.

Aliyugambo commented 4 years ago

Hello guys, As based on my task. see through the attached document

my research.docx

onyijne commented 4 years ago

@nerjib @prominded lets work with @Aliyugambo to close out on this

onyijne commented 4 years ago

@nerjib @prominded lets work with @Aliyugambo to close out on this

Aliyugambo commented 4 years ago

hello sir, regarding the documentation tools i have compile some of the best free documentation tools together which when use check the commit made be me you will see an attered doc with the required information

On Thu, May 14, 2020 at 1:32 AM Samuel Onyijne notifications@github.com wrote:

@nerjib https://github.com/nerjib @prominded https://github.com/prominded lets work with @Aliyugambo https://github.com/Aliyugambo to close out on this

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/BuildForSDG/Phenom-Frontend/issues/5#issuecomment-628481863, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANXPPST7T26MOTP3D34Z4HTRROUDRANCNFSM4M36LHSA .

onyijne commented 4 years ago

Yes, was calling on the attention of other innovators to review your picks.

On Thu, 14 May 2020, 13:20 Aliyu gambo aliyu, notifications@github.com wrote:

hello sir, regarding the documentation tools i have compile some of the best free documentation tools together which when use check the commit made be me you will see an attered doc with the required information

On Thu, May 14, 2020 at 1:32 AM Samuel Onyijne notifications@github.com wrote:

@nerjib https://github.com/nerjib @prominded https://github.com/prominded lets work with @Aliyugambo https://github.com/Aliyugambo to close out on this

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub < https://github.com/BuildForSDG/Phenom-Frontend/issues/5#issuecomment-628481863 , or unsubscribe < https://github.com/notifications/unsubscribe-auth/ANXPPST7T26MOTP3D34Z4HTRROUDRANCNFSM4M36LHSA

.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/BuildForSDG/Phenom-Frontend/issues/5#issuecomment-628596970, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABUCSYEVRUT34WVHY64WOHDRRPOZXANCNFSM4M36LHSA .

prominded commented 4 years ago

@Aliyugambo and I have chosen github/github pages as documentation tool since by default github projects/repositories comes with a README.md file which is used by the github documentation Api.

Phenom frontend developers are advised to learn/used markdown text in editing the readme.md file during coding

onyijne commented 4 years ago

@Aliyugambo and I have chosen github/github pages as documentation tool since by default github projects/repositories comes with a README.md file which is used by the github documentation Api.

Phenom frontend developers are advised to learn/used markdown text in editing the readme.md file during coding

Okay so we use GitHub pages.