Move dev documentation to contributing.md.

README.md

@@ -15,57 +15,17 @@ The two tools offer similar functionality, but are not compatible.
 This version runs on GPU clusters instead of Hadoop clusters.
 It targets CUDA instead of Apache Spark. It is much more extensible.
 
-Check out our [**online demo**](https://lynx-analytics-lynxkite.hf.space/).
-
-## Structure
-
-- `lynxkite-core`: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
-- `lynxkite-app`: The LynxKite web application. Install some plugins then run this to use LynxKite.
-- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
-- `lynxkite-pillow`: A simple example plugin.
-- `docs`: User-facing documentation. It's shared between all packages.
-
-## Development
-
-Install everything like this:
-
-```bash
-uv venv
-source .venv/bin/activate
-uvx pre-commit install
-# The [dev] tag is only needed if you intend on running tests
-uv pip install -e lynxkite-core/[dev] -e lynxkite-app/[dev] -e lynxkite-graph-analytics/[dev] -e lynxkite-pillow-example/
-```
-
-This also builds the frontend, hopefully very quickly. To run it:
-
-```bash
-cd examples && lynxkite
-```
-
-If you also want to make changes to the frontend with hot reloading:
-
-```bash
-cd lynxkite-app/web
-npm run dev
-```
-
-## Executing tests
-
-Run all tests with a single command, or look inside to see how to run them individually:
+## Installation
 
 ```bash
-./test.sh
+pip install lynxkite lynxkite-graph-analytics
 ```
 
-## Documentation
-
-To work on the documentation:
+## Getting started
 
-```bash
-uv pip install mkdocs-material mkdocstrings[python]
-mkdocs serve
-```
+- [Online demo](https://lynx-analytics-lynxkite.hf.space/)
+- [Quickstart](https://lynxkite.github.io/lynxkite-2000/guides/quickstart/)
+- [Contributing](https://lynxkite.github.io/lynxkite-2000/contributing/)
 
 ## License
 

docs/contributing.md

@@ -0,0 +1,54 @@
+# Contributing
+
+The LynxKite 2000:MM repository lives at [https://github.com/lynxkite/lynxkite-2000](https://github.com/lynxkite/lynxkite-2000).
+Bug reports, feature requests, and pull requests are welcome!
+
+## Project structure
+
+- `lynxkite-core`: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
+- `lynxkite-app`: The LynxKite web application. Install some plugins then run this to use LynxKite.
+- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
+- `lynxkite-pillow`: A simple example plugin.
+- `docs`: User-facing documentation. It's shared between all packages.
+
+## Development setup
+
+Install everything like this:
+
+```bash
+uv venv
+source .venv/bin/activate
+uvx pre-commit install
+uv pip install -e 'lynxkite-core/[dev]' -e 'lynxkite-app/[dev]' -e 'lynxkite-graph-analytics/[dev]' -e lynxkite-pillow-example/
+```
+
+This also builds the frontend, hopefully very quickly. To run it:
+
+```bash
+cd examples
+lynxkite
+```
+
+If you also want to make changes to the frontend with hot reloading:
+
+```bash
+cd lynxkite-app/web
+npm run dev
+```
+
+## Executing tests
+
+Run all tests with a single command, or look inside to see how to run them individually:
+
+```bash
+./test.sh
+```
+
+## Documentation
+
+To work on the documentation:
+
+```bash
+uv pip install mkdocs-material mkdocstrings[python]
+mkdocs serve
+```

mkdocs.yml

@@ -4,9 +4,10 @@ repo_name: lynxkite/lynxkite-2000
 watch: [mkdocs.yml, README.md, lynxkite-core, lynxkite-graph-analytics, lynxkite-app]
 
 nav:
-- Home:
+- About LynxKite:
   - Overview: index.md
-  - License: license.md
+  - contributing.md
+  - license.md
 - Guides:
   - guides/quickstart.md
   - guides/analytics.md