-
Notifications
You must be signed in to change notification settings - Fork 1
doc: Roadmap to 1.0.0 #102
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
Open
Jarbuckle
wants to merge
8
commits into
main
Choose a base branch
from
joel/roadmap-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
253655a
Initial roadmap contents
Jarbuckle f806c9b
Update to roadmap
Jarbuckle a1a0169
Merge branch 'main' into joel/roadmap-updates
Jarbuckle e7dc81d
Merge branch 'main' into joel/roadmap-updates
Jarbuckle 32419bb
Merge branch 'main' into joel/roadmap-updates
Jarbuckle 7452cc4
Merge branch 'main' into joel/roadmap-updates
Jarbuckle dacbdc0
Updates to roadmap based on team feedback
Jarbuckle 2f8044a
Merge branch 'main' into joel/roadmap-updates
Jarbuckle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Vis Library Roadmap | ||
|
|
||
| ## Path to 0.1.0 | ||
| - Rename the `vis-scatterbrain` package to `vis-core` | ||
| - Apply error handling across the codebase with consistent formatting, usage of error types and logging | ||
| - Test coverage tools are in place and we're alerted on PRs as to how the coverage has changed | ||
| - Libraries used are updated to latest versions | ||
| - Docs are fleshed out a bit more (can still be markdown and not be fully comprehensive) | ||
| - Examples website is upgraded to be somewhat more user-friendly and easier on the eyes (doesn't have to be fancy) | ||
|
|
||
| ## Path to 1.0.0 | ||
| - Comprehensive, easy to use docs that are deployed to a publically-accessible website, e.g. an mdBook site, an Astro Docs site, etc. | ||
| - Comprehensive docs include tutorials for how to setup and use each package, descriptions of lifecycles of key elements, etc. | ||
| - Live running examples of library components alongside the documentation, with users able to experiment with different settings (ala Storybook) to explore what the visualizations can do | ||
| - Live CodePens or similar available on documentation site to enable code-level experimentation for users | ||
| - Nice/very nice to have: Performance tests triggered by PR changes | ||
| - All packages have been tested extensively for over 6 months without any major issues | ||
| - Package publishing is entirely or significantly automated | ||
| - Changelog has been published | ||
| - Documentation for how to create the changelog has been published | ||
| - The `bkp-client` Scatterbrain capabilities have been translated into a new `vis-scatterbrain` or similar package | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My ideas:
beginLongRunningFramefunction (Remove deprecatedbeginLongRunningFramefromvis-core#139)Examples website is deployed (doesn't have to be pretty)All lint issues are fixedI think on any more!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say the example site should be minimally pretty, maybe we follow some of the bkp client design ideas. I'd be happy to do a design spike for it in figma so that Su and Joel can focus on the more important design stuff
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, minimally pretty is more of what I meant. A little better than what we have now, at the very least lol