Repository navigation
docs: Write memory bank documents for each subsystem - #269
Merged
Merged
Conversation
Contributor
Coverage report
Test suite run success342 tests passing in 20 suites. Report generated by 🧪jest coverage report action from e88d514 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fills the memory bank from the stack's previous PR with one document per subsystem. Each was written from the current code and points to files and function names, not line numbers.
requestFlow.md: how app HTTP and WebSocket traffic reaches the engine with no server. Covers service worker registration,/app_<id>/routing,fetchASGI, the injected socket shim, COOP/COEP/CORP headers, and caching.pythonEngine.md: how Pyodide starts, the worker and main-thread proxies,ResultType, the Python helpers that start and stop apps, how output reaches the terminal, and load status.rEngine.md: how webR starts, the mounted shiny library image,.start_appand.shiny_tick, the httpuv request path, and how R differs from Python.buildPipeline.md: whatmake all,scripts/build.ts,_shinylive, andmake distdo, and howbuild/,site/, and_shinylive/relate.pythonPackageVersions.md(expanded):scripts/pyodide_packages.py, the three lock files, how wheel versions are set, libsass, andupdate_shiny.yml.appModes.md: app modes,runApp()options, URL hash handling, share links, the examples index, and how eachsite_template/page starts.editorLanguageServer.md: the CodeMirror setup, per-file editor state, the in-browser Pyright worker andtypeshed.en.json, and what R gets instead.quartoAndExport.md: the files and formats the externalshinylivepackages and Quarto rely on, which must stay stable.ciAndRelease.md: what each workflow runs, what gates the shinylive.io and GitHub Pages deploys, and how a release is cut.Findings recorded in the docs that may be worth their own issues:
quarto/folder is gone, butREADME.mdandmake quarto/make quartoservestill refer to it.runExportedAppacceptsrelPathand never uses it.runApp()can never fire, becausepropertyOfAppOptionsreturns its input.update_pyodide_pyodide_lock_jsonlooks at the top-level keys of the lock file, not at package names.