Uh oh!
There was an error while loading. Please reload this page.
Docs update - #60
Conversation
rkaminsk
commented
Jun 10, 2026
@copilot resolve the merge conflicts in this pull request |
Resolved all merge conflicts in commit
|
rkaminsk
commented
Jun 10, 2026
I rebased this on the latest master where I also updated the tools. Please have a look whether this is okay with you. Otherwise, we can merge this if potassco.org/project/docs is going to be the final url for the projects. |
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation setup to publish under a /docs subpath, restructures MkDocs navigation using literate-nav + SUMMARY.md, and refreshes various docs pages/assets and supporting project metadata.
Changes:
- Update MkDocs configuration (site URL/output dir, social links, syntax highlighting) and switch navigation to
literate-navdriven bydocs/SUMMARY.md. - Add/replace documentation pages (new “Use” pages, new CLI reference page) and remove older pages that are no longer part of the nav.
- Update doc build/deploy plumbing (doc dependencies, GitHub Pages workflow) and refresh Potassco icon assets/CSS.
Reviewed changes
Copilot reviewed 22 out of 31 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updates doc/dev optional dependencies for MkDocs + plugins. |
| mkdocs.yml | Switches to /docs URL/output dir, adds literate-nav, updates markdown extensions/social icons/favicon. |
| docs/use/quick-start.md | Adds a new Quick Start page that includes README content via snippets. |
| docs/use/installation.md | Adds a new Installation page with pip/CLI verification steps. |
| docs/use/help.md | Adds a new Help/FAQ page (contains issue-tracker links needing correction). |
| docs/SUMMARY.md | Defines the MkDocs navigation via literate-nav. |
| docs/reference/problem/index.md | Removes the old “Problem specification” reference stub. |
| docs/reference/index.md | Simplifies the reference landing page and adjusts formatting. |
| docs/reference/cli/index.md | Adds a new CLI reference page (contains a typo needing correction). |
| docs/getting_started.md | Removes the old getting started page. |
| docs/examples/index.md | Removes emoji from the examples landing page intro. |
| docs/community/index.md | Removes the old community landing page. |
| docs/community/help.md | Removes the old community help page (replaced by docs/use/help.md). |
| docs/assets/images/potassco-logo.svg | Replaces the logo SVG content. |
| docs/assets/images/potassco-logo-dark.svg | Removes the dark logo asset. |
| docs/assets/images/potassco-full-logo.svg | Removes the full logo asset. |
| docs/_custom/overrides/.icons/potassco-logo.svg | Updates the theme icon SVG to use currentColor. |
| docs/_custom/overrides/.icons/potassco-full-logo.svg | Removes the full logo override icon. |
| docs/_custom/css/extra.css | Adds styling for header and admonitions; removes commented-out CSS. |
| DEVELOPMENT.md | Adds/adjusts development install instructions (install command should use [dev]). |
| DEPLOYMENT.md | Updates wording and documents the final docs URL under /docs. |
| CONTRIBUTING.md | Removes emojis and tweaks phrasing/punctuation. |
| .github/workflows/doc.yml | Updates doc build to Python 3.12 and adjusts deployed URL to include /docs/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
susuhahnml
commented
Jun 15, 2026
Shall we merge then? @rkaminsk |
rkaminsk
commented
Jun 22, 2026
@copilot can you review this? Since this is about documentation, can you check if there are any typos or grammar errors and provide a PR with fixes if necessary? |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
This PR updates the documentation setup to publish under a
/docssubpath, restructures MkDocs navigation usingliterate-nav+SUMMARY.md, and refreshes various docs pages/assets and supporting project metadata.Changes:
literate-navdriven bydocs/SUMMARY.md.