Add developer onboarding material as one section in "Developer Manual" #8
Conversation
docs/4-developer/README.md
Outdated
| # Developer Manual | ||
|
|
||
| The development repository is https://github.com/codepod-io/codepod | ||
| The development repository is https://github.com/codepod-io/codepod. Please also check https://github.com/codepod-io/codepod/doc/onboarding.md for the development framework and system architecture description. |
There was a problem hiding this comment.
Instead of adding a link to the codepod.io/codepod source code repo, I think we should put and maintain all .md files here so that they are rendered on our website.
There was a problem hiding this comment.
IIUC,
- codepod.io/docs/4-deverloper/README should sync with codepod-io/codepod/README.
- Add the onboarding doc as one section in ../4-developer/README
- Render the ../4-deverlop/README in codepod-io/codepod/README.
There was a problem hiding this comment.
- codepod.io/docs/4-deverloper/README should sync with
Yes, these two should sync. But I would just remove the dev-setup part from codepod-io/codepod/README, but keep everything in codepod.io/docs/4-deverloper/README.
- ..
Yes
Not render, but just put a link in codepod-io/codepod/README
I'll make this change.
There was a problem hiding this comment.
Now (1) and (3) should be done in #9. You'll be able to work on (2).
There was a problem hiding this comment.
Now (1) and (3) should be done in #9. You'll be able to work on (2).
PR updated.
|
Cool, merging! |
senwang86
changed the title
2 participants
No description provided.