Docs: index.rst: Minor page tuning #889
Merged
Conversation
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
bmunkholm
changed the title
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
reviewed
May 13, 2025
Comment on lines
-34
to
-39
| .. TIP:: | ||
|
|
||
| If you access port ``4200`` via a client library or command-line tool | ||
| like ``curl`` or ``wget``, the request will be handled by the `CrateDB | ||
| Rest API`_, and the response will be in JSON. | ||
|
|
There was a problem hiding this comment.
I agree it doesn't need to be priority information, but it is still viable information for readers of the documentation, and might just be relocated instead?
There was a problem hiding this comment.
I was assuming this wasn't the only place this tip was provided, but more of a reference tip.
So I created an issue to consider where that should go in case it isn't mentioned somewhere else.
amotl
approved these changes
May 13, 2025
amotl
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 of the changes / Why this is an improvement
Overall the intent is to remove any "noise" that before getting started.
Preview
Before
After