doc: Roadmap to 1.0.0 #102
Conversation
| @@ -0,0 +1,8 @@ | |||
| # Vis Library Roadmap | |||
|
|
|||
| ## Path to 0.1.0 | |||
There was a problem hiding this comment.
My ideas:
- Remove the deprecated
beginLongRunningFramefunction - Examples website is deployed (doesn't have to be pretty)
- Test coverage tools are in place and we're alerted on PRs as to how the coverage has changed
- All lint issues are fixed
- Libraries used are updated to latest versions
- Docs are fleshed out a bit more (can still be markdown and not be fully comprehensive)
I think on any more!
There was a problem hiding this comment.
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.
Yeah, minimally pretty is more of what I meant. A little better than what we have now, at the very least lol
| - Create a `vis-core` package that is the base dependency of all other `vis` packages, containing basic internal mechanisms (such as logging). | ||
|
|
||
| ## Path to 1.0.0 | ||
| - TBD |
There was a problem hiding this comment.
My ideas:
- Comprehensive, easy to use docs (deployed to a website, something like mdBook for a basic version or we get super fancy with Astro and include live-running examples alongside the docs
- Pretty example site with lots of widgets for tweaking running examples without the need for JS commands in the console
- More testing
- Performance tests that run on PR changes (this is a maybe, but nice to have if we're aiming to be the high performance visualization toolkit)
- Packages have all been battle-tested for at least six months or so, with no major problems
- Package publishing is more fully automated
- Comprehensive changelog is published and we have documented how to do the changelog accurately
I think on further items and add here when I think of them!
There was a problem hiding this comment.
adding on top of Lane's ideas:
- add more context and description in the example usage docs, especially outlining the standard set up and cycle?
There was a problem hiding this comment.
live working versions alongside the docs would be great, tanstack docs are fantastic. We could potentially just embed codepens and make keeping them up to date part of our update tasks
There was a problem hiding this comment.
Public Codepens are MIT Licensed, not sure how that works with our licensing
https://blog.codepen.io/documentation/licensing/
Codesandbox also has MIT licensing
I haven't read through it but there's a github list of code playgrounds if we need to look around
There was a problem hiding this comment.
I've been tempted to use Astro's Starlight documentation site for this codebase. We could embed the working examples right in with the documentation
There was a problem hiding this comment.
I was more thinking the code editor part of it might be helpful for people to poke at the examples rather than having to install the repo to do so
doc: Roadmap to 1.0.0
What
This PR contains the WIP doc for the Roadmap for the
vislibrary. For this iteration, the goal is to work together to define/refine our roadmap to 1.0.0, with particular focus on what our goals are for achieving the first minor version release, 0.1.0, and what steps from there will take us to 1.0.How
Created
src/docs/roadmap.md.All team members are invited to contribute suggestions and/or updates to this document! This PR will remain open until we're satisfied with the plan for reaching 0.1.0 and 1.0.0.
PR Checklist
main?