Tracking issue for docs unification #112
Conversation
- Remove Astro/Starlight setup (src/, package.json, etc.) - Add MkDocs configuration with Material theme - Add mkdocs-multirepo-plugin to pull docs from atuin and desktop repos - Add pyproject.toml for uv package management - Add landing page pointing to CLI and Desktop docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
@ellie To test, you can pull this PR down and run |
|
@BinaryMuse what's the plan for the open PRs in this repo? I have recreated my PRs #110 and #111 as atuinsh/atuin#3063 and atuinsh/atuin#3062, respectively, but what should happen with the others? Do you need help recreating them in the main repo? I'd be happy to give it a shot. |
|
I moved my PR #106 to the main repository |
That's very kind of you, thanks. I'm getting them migrated over right now; once that's done, I'll do a pass and merge the ones that are ready. |
Just a few punctuation, spelling and grammar fixes, along with a couple of wording changes for clarity. _Note: This PR is a recreation of atuinsh/docs#110, following the migration of the docs to this repo (atuinsh/docs#112 + #3018)._ <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing Co-authored-by: Michelle Tilley <michelle@michelletilley.net>
Moved from atuinsh/docs#106. Since the PRs in [`atuin/docs`](https://github.com/atuinsh/docs) seem to have been invalidated by atuinsh/docs#112 and #3018, let me re-create the PR here. This is the documentation update associated with the change introduced in [#2953](#2953). The current documentation about Bash's bindings is outdated. ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
This PR serves as a main tracking issue for unifying the Atuin CLI and Atuin Desktop docs.
atuinsh/docsis now a mkdocs-based site, using a forked version of themkdocs-multirepo-plugin. This was forked due to several issues with the features, which have been fixed for our use.Both
atuinsh/atuinandatuinsh/desktophave adocsfolder with their own mkdocs site, which can be previewed locally withuv run mkdocs serve. It will clone the appropriate files from this repository to ensure theming, etc. is consistent.TODO:
maininstead of the testing branch