Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken short code syntax displayed in docs #210

Closed
Tracked by #208
alice-i-cecile opened this issue Aug 11, 2021 · 7 comments
Closed
Tracked by #208

Fix broken short code syntax displayed in docs #210

alice-i-cecile opened this issue Aug 11, 2021 · 7 comments

Comments

@alice-i-cecile
Copy link
Member

On https://bevyengine.org/learn/book/contributing/docs/ I see:
image

@cart
Copy link
Member

cart commented Aug 11, 2021

Hmm maybe this was the result of a recent Zola update? The shortcodes for open/close parens were built specifically for this section (and they used to work).

@alice-i-cecile
Copy link
Member Author

That makes sense. It's failing locally for me too (now that I'm on 0.14).

Are you potentially on-board with just migrating this content to CONTRIBUTING.md here on Github? It's not very useful for new readers, and that lets us bypass the whole problem.

@cart
Copy link
Member

cart commented Aug 13, 2021

I personally like having "contributing" content in the book for a number of reasons:

  • It subtly sends the message to people new to Bevy that contributing is a core "part" of Bevy.
  • It shows new users how easy it is to contribute. If they are browsing The Book, they might just casually read through the Contributing section without explicitly seeking it out (which they would need to do for a Contributing.md file). They might not think to seek it out because they might consider contributing "inaccessible". If its in The Book, we get a chance to "convert" them.
  • It allows us to use The Book formatting and tooling, which are significantly "better" than raw markdown files or "github rendered markdown".

@alice-i-cecile
Copy link
Member Author

I can get behind that. Ideally we can get some automatic synchronization with the CONTRIBUTING.md files in both repos?

@cart
Copy link
Member

cart commented Aug 13, 2021

Can we just have our CONTRIBUTING.md link to the book? That eliminates the "sync" problem and ensures a consistent user experience.

@alice-i-cecile
Copy link
Member Author

Can we just have our CONTRIBUTING.md link to the book? That eliminates the "sync" problem and ensures a consistent user experience.

I'm on board with this. We should finish the reviews in bevyengine/bevy#2040, add a section on short-codes to it, and then migrate it over to the website.

@cart
Copy link
Member

cart commented Aug 13, 2021

Sounds good to me!

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

No branches or pull requests

2 participants