Skip to content

Conversation

@senwang86
Copy link
Collaborator

  • A summary of the development framework, repo brief description and system architecture.

@senwang86 senwang86 marked this pull request as draft June 21, 2023 19:14
@lihebi
Copy link
Collaborator

lihebi commented Jun 21, 2023

Thanks!

One general thinking: should we put documentation on our website? It's easier and more organized for people to access.

The website repo is: https://github.com/codepod-io/codepod.io

@lihebi
Copy link
Collaborator

lihebi commented Jun 21, 2023

E.g., this is the user manual page: https://codepod.io/docs/manual/
this is the developer manual page: https://codepod.io/docs/developer/

@lihebi
Copy link
Collaborator

lihebi commented Jun 21, 2023

I'm thinking about putting all documents (including the dev env setup in the root README) to the website repo, and maintain the docs there. We could leave a link to the user manual and developer manual in the README of this repo. What do you think? @forrestbao

@senwang86
Copy link
Collaborator Author

Thanks!

One general thinking: should we put documentation on our website? It's easier and more organized for people to access.

The website repo is: https://github.com/codepod-io/codepod.io

Sounds good, here's the PR for the website change, codepod-io/codepod.io#8

@forrestbao
Copy link
Collaborator

forrestbao commented Jun 22, 2023

I'm thinking about putting all documents (including the dev env setup in the root README) to the website repo, and maintain the docs there. We could leave a link to the user manual and developer manual in the README of this repo. What do you think? @forrestbao

I agree. But do not put business sensitive information there. Only docs we want to make public.

@senwang86 senwang86 marked this pull request as ready for review June 22, 2023 18:25
@senwang86
Copy link
Collaborator Author

OK, I will close this PR and start another one on the website repo.

@senwang86
Copy link
Collaborator Author

Drop this PR and please refer codepod-io/codepod.io#8 for the changes.

@senwang86 senwang86 closed this Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants