ROADMAP

[cyrilou242]

Feel free to open an issue if you'd like to work on one of these points.

P0:

• Implement build/release process.
• Implement distribution/installation. Clarify how jnotebook-utils will be distributed. Consider a wrapper model.
• Show a list of available files to launch a notebook directly
• Package javascript dependencies to work offline
• Add Nb.table
• FIX MARKDOWN line return is forcing a line return in the generated markdown
• FIX MARKDOWN change go block should change
• FIX markdown <code> looks bad
• FIX every bugs in bugs.md
• Force replay everything button
• The generation flow should not break on an exception. If possible, it should be surfaced in the UI - see bugs for this
• Add quickstart to README

P1:

• FIX - TOCC does not get h3
• Implement MAGICS: hide, hideCode, hideResult, collapse, collapseCode, collapseResult
• Makes it easy to generate good looking reports
• Improve integration with IDEs
• Fix std err / out implementation following use of local engine
• Add tests
• make distribution and installation easy. dependency/brew install/maven plugin/maven dependency
• Remove all checked exceptions
• CODE QUALITY: make all server things implement closable
• Add glob pattern to render generation
• Move ToC generation to java side - the current one is pretty bad
• If no internet connection, javascript dependencies cannot be fetched — get a way to have them available off-line
• implement --version command
• Button to rebuild dependencies / build command pattern? Watching dependencies and rebuild if they are changed automatically? (difficult - maybe just say that the dependency was updated and notebook is not up to date?)

P2:

• FIX Nb.profile when the profile is empty: send a warning somehow
• by default Nb.flamegraph should only return the flame for the runnable of Nb.profile is run by default
• Add a convert to java entrypoint
• Make it work from a java class ??
• Make it work from a markdown class ??
• Add list of files to the welcome screen
• Add table viewer
• Add image viewer
• never get broken on a parsing error
• FIX Process error stacks - and better exception return (don't return the jshell exception)
• Extract tailwind css and templatize it
• Generate java doc - esp for jnotebook-utils - document utils see https://javadoc.io/ and https://stackoverflow.com/questions/5927590/maven-multi-module-project-site-with-javadocs
• dedicated website
• contributor license agreement?
• Notification system: when a long running job is done (= when the notebook is computed) (see Notebooks as products in What’s wrong with computational …), notify —> can exploit browser notifications for this easily
• Suggest a way to make notebook parametrisable: just start with a bunch of System.getEnviron(KEY, DEFAULT)
• Maven quickStart project for new explorations
• Create a wrapper
• consider using graalVM
• consider partial re-rendering instead of full-re-rendering everytime
• add a Nb.tab component

P3:

• Manage control-z and history —> ie maintain an history of previously compiled results? To avoid compute/forget/re-compute. Ie time-travel like feature - it seems NextJournal is doing this.
• Show diff - point to what changed in the rendered notebook
• Think about a comment system - with crdc ?
• Move code highlighting to java side
• The UI should be themable - ie the font, size and spaces should not be enforced - important for devs. System of overloading themes?
• Add code quality tooling - eg sonarQube
• Think about 2 way code (not a fan, but a least consider it - can be helpful for small editions) - don't want to build a full fledge IDE though.