Colin Diesh
Colin Diesh
address https://github.com/GMOD/jbrowse-components/issues/3280
Review quickstart guide: this is an important document, and in the middle it switches from using npx serve to --out /var/www/html/jbrowse2 without explanation https://jbrowse.org/jb2/docs/quickstart_web/ Also review this repo's README.md. could...
I also still think there is value in making a superquickstart. it could be made into a TLDR at the top of the quickstart. this was, at one point, deleted...
the quickstart also does not have links to example files. it could essentially mirror the protocols paper, but with smaller files
possible idea; use an ai to aid documentation process. AI can generate a bunch of plausible looking stuff, lowering the barrier to just getting it done. we have not established...
- document PIF - document (or add to every code example?) memo-izing createViewState in embedded. need to decide 'best' memoize method if adding to all
mention in various places where plugins are documented e.g. https://jbrowse.org/jb2/docs/tutorials/no_build_plugin_tutorial/ that embedded apps can use a different technique
make a better doc-type storybook page for the "observer" examples (currently it is only under source code examples) make synteny example in the react-app storybook
create troubleshooting guide for text indexing not working motivated by office hours which required using --force to reindex cause existing was a 0 byte ix and ixx file
(could also make text-index output the currently indexed tracks to make this more clear to user)