Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve our internal documentation #314

Merged
merged 1 commit into from
May 28, 2024
Merged

Conversation

wwwillchen
Copy link
Collaborator

Anything else that you think should be refreshed?

@wwwillchen wwwillchen requested a review from richard-to May 27, 2024 06:10
@richard-to
Copy link
Collaborator

For the development page, maybe add a line explaining the use cases where you would use Dev Mode instead of Regular Mode.

One thing I have on my TODO list is to get my VS Code workspace running correctly. Been working without linting / protos / etc set up. So I'll try to run the instructions there.

I skimmed through the rest of the documentation and it seems current to me.

@wwwillchen
Copy link
Collaborator Author

For the development page, maybe add a line explaining the use cases where you would use Dev Mode instead of Regular Mode.

One thing I have on my TODO list is to get my VS Code workspace running correctly. Been working without linting / protos / etc set up. So I'll try to run the instructions there.

I skimmed through the rest of the documentation and it seems current to me.

I'm going to open a follow-up PR to clean-up our dev mode, it actually doesn't work anymore and I don't think there's a ton of benefit to it with a bit of tweaking our main CLI.

Try to setup the VS code workspace :) It's a bit of work but then it's really nice to get proper intellisense, type-checking!

@wwwillchen wwwillchen merged commit 55c7fbb into google:main May 28, 2024
3 checks passed
@wwwillchen wwwillchen deleted the fix_dev_docs branch May 28, 2024 05:06
wwwillchen added a commit to wwwillchen/mesop that referenced this pull request Jun 14, 2024
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.

2 participants