From 253655a7f4674dcb46ea2f159e4ace76f8789726 Mon Sep 17 00:00:00 2001 From: Joel Arbuckle Date: Mon, 17 Mar 2025 11:56:49 -0700 Subject: [PATCH 1/3] Initial roadmap contents --- docs/roadmap.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/roadmap.md diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 00000000..fc5b715b --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,8 @@ +# Vis Library Roadmap + +## Path to 0.1.0 +- Rename the `vis-scatterbrain` package to `vis-rendering` +- 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 \ No newline at end of file From f806c9be2b89e5aa6b294c14ed51a4dcab21f255 Mon Sep 17 00:00:00 2001 From: Joel Arbuckle Date: Mon, 17 Mar 2025 12:25:59 -0700 Subject: [PATCH 2/3] Update to roadmap --- docs/roadmap.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/roadmap.md b/docs/roadmap.md index fc5b715b..d523a15a 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -3,6 +3,7 @@ ## Path to 0.1.0 - Rename the `vis-scatterbrain` package to `vis-rendering` - Create a `vis-core` package that is the base dependency of all other `vis` packages, containing basic internal mechanisms (such as logging). +- Apply error handling across the codebase with consistent formatting, usage of error types and logging ## Path to 1.0.0 - TBD \ No newline at end of file From dacbdc025043adeae4ccde7573a614d89ce2d986 Mon Sep 17 00:00:00 2001 From: Joel Arbuckle Date: Mon, 28 Apr 2025 10:51:04 -0700 Subject: [PATCH 3/3] Updates to roadmap based on team feedback --- docs/roadmap.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/roadmap.md b/docs/roadmap.md index d523a15a..4450cf8b 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,9 +1,21 @@ # Vis Library Roadmap ## Path to 0.1.0 -- Rename the `vis-scatterbrain` package to `vis-rendering` -- Create a `vis-core` package that is the base dependency of all other `vis` packages, containing basic internal mechanisms (such as logging). +- 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 -- TBD \ No newline at end of file +- 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