Add user-facing documentation#78
Merged
Merged
Conversation
Creates a docs/ folder with getting-started, CLI reference, MCP server, API client, local backend, configuration, and data models pages, and links them from the README so contributors and users can find them without relying solely on the hosted docs site.
Switches the docs list in the root README and in docs/README.md from bullets to a two-column table so the page and its description line up visually.
Covers prerequisites (elan/lake, OPENROUTER_API_KEY, the [extract] extra), the four stages (doc-gen4 -> parse -> informalize -> embed -> index), common invocations for full rebuilds and single-stage reruns, the main flags, and the timestamped output layout under LEAN_EXPLORE_DATA_DIR.
Rewrites every em dash in the documentation, using colons for definitional lists, parentheses for asides, and semicolons or sentence breaks where the dash was separating independent clauses.
Readers need install instructions first; the docs table now follows installation so it lands in a more natural spot for people skimming the README top-to-bottom.
Promotes the license line into its own section at the bottom so the flow reads installation -> documentation -> contributing -> cite -> license.
Surfaces the list of packages LeanExplore covers immediately after the one-line description, so readers see the scope before hitting install instructions.
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.
Summary
docs/folder with seven pages covering getting started, the CLI, the MCP server, the API client, the local backend, configuration, and data modelsdocs/README.mdindex with a backend-comparison table and links to each pageREADME.mdso they're discoverable in-repo