Docs simplification #220
Docs simplification #220
Conversation
WalkthroughThe changes remove local table of contents rubrics and directives from multiple documentation files and delete the centralized index-all documentation page. The main index file is simplified, with detailed project information and navigation links consolidated or removed. No code or public API changes are included. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (14)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
docs/advanced-querying.rst(0 hunks)docs/crud.rst(0 hunks)docs/dataframe.rst(0 hunks)docs/getting-started.rst(0 hunks)docs/index-all.rst(0 hunks)docs/index.rst(4 hunks)docs/install.rst(0 hunks)docs/overview.rst(0 hunks)docs/working-with-types.rst(0 hunks)
💤 Files with no reviewable changes (8)
- docs/install.rst
- docs/working-with-types.rst
- docs/advanced-querying.rst
- docs/crud.rst
- docs/dataframe.rst
- docs/overview.rst
- docs/index-all.rst
- docs/getting-started.rst
⏰ Context from checks skipped due to timeout of 90000ms (17)
- GitHub Check: Python: 3.13 SQLAlchemy: latest
- GitHub Check: Python: 3.13 SQLAlchemy: <2.1
- GitHub Check: Python: 3.13 SQLAlchemy: <1.5
- GitHub Check: Python: 3.12 SQLAlchemy: <2.1
- GitHub Check: Python: 3.12 SQLAlchemy: <1.5
- GitHub Check: Python: 3.11 SQLAlchemy: <2.1
- GitHub Check: Python: 3.11 SQLAlchemy: <1.4
- GitHub Check: Python: 3.10 SQLAlchemy: <2.1
- GitHub Check: Python: 3.9 SQLAlchemy: <2.1
- GitHub Check: Python: 3.9 SQLAlchemy: <1.5
- GitHub Check: Python: 3.9 SQLAlchemy: <1.4
- GitHub Check: Python: 3.8 SQLAlchemy: <2.1
- GitHub Check: Analyze with SQLAlchemy <2.1
- GitHub Check: Python: 3.7 SQLAlchemy: <1.5
- GitHub Check: Analyze with SQLAlchemy <1.5
- GitHub Check: Python: 3.7 SQLAlchemy: <1.4
- GitHub Check: Analyze with SQLAlchemy <1.4
🔇 Additional comments (2)
docs/index.rst (2)
55-55: Ensure the reference link target exists for the install pagePlease verify that the anchor in
docs/install.rstmatches:ref:\install`` so that this inline link resolves correctly. Otherwise, consider a fully qualified reference such as:See also the :ref:`install <install>` page for details.
90-90: These hunks only trim trailing whitespace in code examples and do not change the documentation’s semantics.Also applies to: 116-116, 119-119
| ******************* | ||
| Project information | ||
| ******************* | ||
|
|
||
| Resources | ||
| ========= | ||
| - `Source code <https://github.com/crate/sqlalchemy-cratedb>`_ | ||
| - `Documentation <https://github.com/crate/sqlalchemy-cratedb>`_ | ||
| - `Python Package Index (PyPI) <https://pypi.org/project/sqlalchemy-cratedb/>`_ | ||
|
|
||
| Contributions | ||
| ============= | ||
| The SQLAlchemy dialect for CrateDB is an open source project, and is `managed on | ||
| GitHub`_. | ||
| Every kind of contribution, feedback, or patch, is much welcome. `Create an | ||
| issue`_ or submit a patch if you think we should include a new feature, or to | ||
| report or fix a bug. | ||
|
|
||
| Development | ||
| =========== | ||
| In order to setup a development environment on your workstation, please head | ||
| over to the `development sandbox`_ documentation. When you see the software | ||
| tests succeed, you should be ready to start hacking. | ||
|
|
||
| Page index | ||
| ========== | ||
| The full index for all documentation pages can be inspected at :ref:`index-all`. | ||
|
|
||
| License | ||
| ======= | ||
| The project is licensed under the terms of the Apache 2.0 license, like | ||
| `CrateDB itself <CrateDB source_>`_, see `LICENSE`_. | ||
|
|
There was a problem hiding this comment.
Maybe add fragments of those to the project README instead? In this case, we are getting rid of it on the documentation, but still can use it on the GitHub page, which is more distant to the former.
There was a problem hiding this comment.
Good point! I already did check the readme and there isn't anything here that's not already part of the readme apart from the License not being mentioned directly. But I think that's no longer needed since it's shown by Github already in the right sidebar.
Let me know if I overlooked anything.
|
Please let me know if you would like to receive guidance on this spot.
|
|
@amotl I just needed to add "Hidden" in the TOC directive for install page instead of removing it entirely. That's also on other pages. And I would like to remove that as it serves only to clutter now that we have page local righthand TOC. So in general, I think we should only have left hand toc entries for anything that is it's own page, and leave navigation on the page headers to the right hand toc. |
|
Hi Brian. In full documentation assembly mode, this spot within the CrateDB documentation theme's Unfortunately, the spot is in a remote repository, and this certainly qualifies as a general architecture flaw, but c'est la vie: I haven't been able to improve the situation in one way or another yet. It currently is a central place where things are stitched together 1.
Heads up: It could be worse. ;] Footnotes
|
|
Thank you so much for saving me a great deal of headscratching! I will deal with that separately then. |
About
Remove page local toc and Project info section as it's redundant.
Preview
https://sqlalchemy-cratedb--220.org.readthedocs.build/