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

Add roadmap section to the README #510

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Add roadmap section to the README #510

merged 2 commits into from
Jan 31, 2024

Conversation

georg-schwarz
Copy link
Member

@georg-schwarz georg-schwarz commented Jan 18, 2024

We should share our roadmap and vision of Jayvee with the world.

See the rendered README here

Screenshot

image

@rhazn
Copy link
Contributor

rhazn commented Jan 22, 2024

I notice you always link to the rendered md file, did you know you can see the rich diff in files (https://github.com/jvalue/jayvee/pull/510/files) and there for all md files on the right side of the file name? It's a cool feature of github imho :D

Copy link
Contributor

@rhazn rhazn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not a big fan of having the roadmap here because I assume it will get out of sync with what we are doing quick and that looks even worse (because now we have three different locations for a roadmap, the readme, the issues here, our internal tracking).

I would argue we should try to somehow have a public roadmap that auto updates itself. I realize that is hard though.

To not let perfect be the enemy of good, I am happy with approving this.

@georg-schwarz
Copy link
Member Author

I notice you always link to the rendered md file, did you know you can see the rich diff in files (https://github.com/jvalue/jayvee/pull/510/files) and there for all md files on the right side of the file name? It's a cool feature of github imho :D

Amazing :) I'm surprised that I successfully ignored that feature until now. Thanks!

I am not a big fan of having the roadmap here because I assume it will get out of sync with what we are doing quick and that looks even worse (because now we have three different locations for a roadmap, the readme, the issues here, our internal tracking).

I totally agree... I'd keep it on a very broad scope here so that it does not require frequent updates.

@georg-schwarz georg-schwarz merged commit 131ba21 into main Jan 31, 2024
3 checks passed
@georg-schwarz georg-schwarz deleted the document-roadmap branch January 31, 2024 09:38
@github-actions github-actions bot locked and limited conversation to collaborators Jan 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants