Skip to content

General documentation fixes#2463

Draft
onkoe wants to merge 3 commits intogetzola:masterfrom
onkoe:docs-pr-update
Draft

General documentation fixes#2463
onkoe wants to merge 3 commits intogetzola:masterfrom
onkoe:docs-pr-update

Conversation

@onkoe
Copy link

@onkoe onkoe commented Mar 19, 2024

Discussion issue: #2426

This PR aims to fix some tonal and guidance inconsistencies within the Zola docs. For now, I won't make any sweeping changes, as tera2 has progressed quite a lot!

I'd be happy to focus on particular pages if anyone has any suggestions! :)

Copy link
Collaborator

@Keats Keats left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for the late review :(
It would be nice to revert the list change so it's easier to review

Zola uses the directory structure to determine the site structure.
Each child directory in the `content` directory represents a [section](@/documentation/content/section.md)
that contains [pages](@/documentation/content/page.md) (your `.md` files).
Zola determines your site's structure from its directories. Each child folder in the `content` directory represents a separate [section](@/documentation/content/section.md)[^1]that contains [pages](@/documentation/content/page.md) (your `.md` files).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* `id`: the video id (mandatory)
* `playlist`: the playlist id (optional)
* `class`: a class to add to the `<div>` surrounding the iframe
* `autoplay`: when set to "true", the video autoplays on load
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we revert the - -> * changes? It's the same meaning and it causes unnecessary diff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants