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

Document decks more specifically #2053

Open
bernhold opened this issue Mar 27, 2024 · 0 comments
Open

Document decks more specifically #2053

bernhold opened this issue Mar 27, 2024 · 0 comments

Comments

@bernhold
Copy link
Member

We should make sure the decks are documented properly. Some of the key points...

  • Decks should be short (~1 sentence)e as a teaser, to give the user a reason to read further
  • The first paragraph of the article is treated as the deck.
    • Except in blog articles with a hero image, in which case there is no deck
  • A useful convention in the source is to place the deck before the Contributed by and Publication date headings.
  • Another common convention in the source is to bracket the deck with HTML comments
  • But it is important to be aware that neither the position nor the comments have any impact on how the frontend interprets the source -- the first paragraph is formatted as the deck, except for blog articles with hero images.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

No branches or pull requests

1 participant