Remove leftover MkDocs infrastructure#40
Open
Jayanaka-98 wants to merge 1 commit into
Open
Conversation
The site is now a Jac web app (main.jac + jac-client/jac-scale); the MkDocs build/serve stack is dead. Remove it: - Config/build: mkdocs.yml, setup.py, jac_syntax_highlighter.py (Pygments lexer used only by MkDocs), Dockerfile + .dockerignore (ran mkdocs_serve.py; deploy uses jac-scale). - Scripts: scripts/mkdocs_serve.py and scripts/inject_excerpt_peek.py (its excerpt logic is reimplemented in main.jac as extract_peek_markdown). - Front-end assets only MkDocs referenced: docs/extra.css, docs/js/*, docs/playground/language-configuration.json, docs/index.md, docs/blog/index.md. Kept scripts/handle_jac_compile_data.py: although it was wired as an MkDocs hook, it generates docs/playground/jaclang.zip that main.jac serves to the in-browser Pyodide runner, and it runs fine standalone. Editorial scheduling (schedule_lib.py, workflows, tests) and docs/blog content are untouched. Updated README.md and CLAUDE.md to document the Jac app instead of MkDocs (install/run/deploy, project structure, and free-form categories now derived by the GetCategories walker rather than an mkdocs.yml allowlist).
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
1 participant
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.
What
The site is now a Jac web app (
main.jac+ jac-client/jac-scale); the MkDocs build/serve stack is dead weight. This removes it. Branched fresh frommain, so the diff is only the MkDocs removal.Removed (~3.5k lines):
mkdocs.yml,setup.py,jac_syntax_highlighter.py(Pygments lexer used only by MkDocs),Dockerfile+.dockerignore(ranmkdocs_serve.py; deploy uses jac-scale)scripts/mkdocs_serve.py,scripts/inject_excerpt_peek.py(its excerpt logic is reimplemented inmain.jacasextract_peek_markdown)docs/extra.css,docs/js/*,docs/playground/language-configuration.json,docs/index.md,docs/blog/index.mdKept (verified still used):
scripts/handle_jac_compile_data.py— wired as an MkDocs hook, but it generatesdocs/playground/jaclang.zipthatmain.jacserves to the in-browser Pyodide runner; runs fine standalone.schedule_lib.py, workflows, tests) and alldocs/blog/content +docs/assets/are untouched.Docs / comments:
README.mdandCLAUDE.mdfor the Jac app (install/run/deploy, project structure).main.jac(ALLOWED_CATEGORIES) no longer points at the deletedmkdocs.yml;CLAUDE.mdnow documentsALLOWED_CATEGORIESas the source of truth.Verified no live
.jac/.py/.toml/workflow code references any removed file.Follow-up (not in this PR)
deploy.ymlrunsjac start main.jac --scalebut never generatesjaclang.zip(the MkDocs hook only ran duringmkdocs build). Consider adding a step to runhandle_jac_compile_data.pybefore deploy so runnable code blocks have the runtime in-pod.