Prod 2161 improve documentation -> PROD 120 FMD

topcoder-platform / mfe-customer-work

3 stars 10 forks source link

Prod 2161 improve documentation -> PROD 120 FMD #455

Closed hentrymartin closed 2 years ago

hentrymartin commented 2 years ago

What's in this PR?

List of task planned to be done as part of this PR,

[x] Mention current .nvmrc version in the document
[x] Create an index or content list in the top of the documentation
[x] Mention about branching strategy
[x] Explain about Aggregator API
[x] Why TSLint has to be installed globally?
[x] Why there are two src folders?
[x] Link the confluence page as part of the documentation

hentrymartin commented 2 years ago

@brooketopcoder I am planning to improve the above mentioned things in the readme file. But, I need some clarity on certain things before doing that. I will comment exact questions separately and tag you. Please try to answer them :)

hentrymartin commented 2 years ago

@brooketopcoder I've updated the readme with TBD section. Can you please review it?

hentrymartin commented 2 years ago

@testflyjets This PR is ready for review. Can you please review this PR?