docs: split the README into a user page, an architecture page and a citations page - #417
Merged
Merged
Conversation
…itations page (#416) The README keeps what a user needs: install, quick start, the query surface by family, backend selection, and where to read next. The contributor module map moves to docs/architecture.md (linked from CONTRIBUTING) and the Cited By list to docs/citations.md, both verbatim. The agent guide gains two operational notes: project_path and the analysis cache, and the JDK a Java call graph needs from level 2 up.
4 tasks
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.
Closes #416.
core.py, backend selection by the type ofbackend=, models and backends per language, shared result types. Linked from CONTRIBUTING under "Repository layout".project_pathrules and the analysis cache undercache_dir(the Python analyzer's virtualenv lives there, so the first run is slower); Java call graphs need a JDK withjavacfrom level 2 up, else the run exits 0 with declared edges only.Checked before opening. Every relative link in the five touched files resolves; the mermaid block parses as a single fence. Each factual claim was read against the code:
callers_ofreturnsSliceNodewithfile/line/callable;get_commentsis on the Java facade only; the Java backend logs an incomplete level atWARNING;project_pathmust be an existing directory on every backend; codeanalyzer-python's virtualenv iscache_dir/<project>/virtualenv; thecldk[all]extra exists;requires-python >= 3.11; the legacy entry emitsDeprecationWarning; the analyzer table's Scalpel / RTA / def-use linker descriptions match the analyzers' own docs.Out of scope, pre-existing. CONTRIBUTING links
CODE_OF_CONDUCT.md, which exists neither in this repo nor at the org config repo's root. Left as is.Docs only. Merge-only on the ship decision: the docs are not built from a tag.