[PR-23489] [Documentation] Fix indentation #351
Conversation
README.md
Outdated
| #### General Formatting Rules | ||
|
|
||
| 1. **Directives (`..` syntax)**: | ||
| - All directives starting with `..` (e.g., `.. image::`, `.. note::`) must have **2 spaces** indentation for their content. Examples: |
There was a problem hiding this comment.
Why did you choose 2 spaces? I prefer 3 and this what we most commonly have.
I chose 3 because that’s what RST documentation uses everywhere and what looks best.
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
cc @wrimer
There was a problem hiding this comment.
In the reStructuredText (RST) documentation, there are no strict rules mandating the use of 2 or 3 spaces for indentation. In our project, I didn’t see a significant advantage to using 3 spaces.
Therefore, I decided to standardize on 2 spaces because it’s the minimal value and the quickest to write.
There was a problem hiding this comment.
@Buritos16 Okay. You still have 3 spaces here:
https://github.com/talkable/talkable-docs/blob/4f74b18f26d699ac2aceba2a0dace30a79812fec/source/advanced_features/google_login.rst#L87-L88
https://github.com/talkable/talkable-docs/blob/4f74b18f26d699ac2aceba2a0dace30a79812fec/source/advanced_features/passing_custom_data.rst#L82-L85
https://github.com/talkable/talkable-docs/blob/4f74b18f26d699ac2aceba2a0dace30a79812fec/source/campaigns/editor/videos.rst#L47-L49
https://github.com/talkable/talkable-docs/blob/4f74b18f26d699ac2aceba2a0dace30a79812fec/source/integration/ecommerce_platforms/shopify.rst#L313-L315
https://github.com/talkable/talkable-docs/blob/4f74b18f26d699ac2aceba2a0dace30a79812fec/source/partials/common.rst
There was a problem hiding this comment.
@zhuravel If needed, I can switch to 3 spaces.
There was a problem hiding this comment.
Switch those places I’ve mentioned to 2 spaces as everywhere.
Author: Roman Typylo <[email protected]> [PR-23489] [Documentation] Fix indentation (#351)
Demo
https://deploy-preview-351--talkable-docs.netlify.app/
Related Stories