Skip to content

docs: add Markdown formatting guidance for project descriptions#347

Merged
grantoesterling merged 1 commit into
mainfrom
docs/description-formatting
May 6, 2026
Merged

docs: add Markdown formatting guidance for project descriptions#347
grantoesterling merged 1 commit into
mainfrom
docs/description-formatting

Conversation

@j3r3mys
Copy link
Copy Markdown
Collaborator

@j3r3mys j3r3mys commented May 6, 2026

Summary

  • Adds an Artist FAQ entry on Markdown formatting in the project description field, including the   workaround for paragraph breaks (a recurring artist support question).
  • Adds a one-line cross-reference from the "Writing Your Project Description" subsection of the staging guide so artists discover the formatting tip while drafting.

Background

Artists frequently ask how to insert line breaks in the description field. <br> tags and trailing double-spaces don't work because Markdown collapses whitespace; the working pattern is &nbsp; on its own line. This documents the supported Markdown (bold, italics, headers, links) alongside the line-break workaround.

Test plan

  • Render the Retype site locally and confirm the new FAQ entry displays correctly under Creator Dashboard
  • Verify the cross-reference link from 2-staging-and-testing.md resolves to the right FAQ anchor
  • Confirm the &nbsp; example renders as intended in the code block

🤖 Generated with Claude Code

Adds an Artist FAQ entry covering supported Markdown (bold, italics,
headers, links) and the &nbsp; workaround for paragraph breaks, plus a
cross-reference from the staging guide's description-writing section.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@j3r3mys j3r3mys requested a review from a team as a code owner May 6, 2026 16:55
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://ArtBlocks.github.io/artblocks-docs/pr-preview/pr-347/

Built to branch retype at 2026-05-06 16:56 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@grantoesterling grantoesterling merged commit 1c47b3a into main May 6, 2026
3 checks passed
@grantoesterling grantoesterling deleted the docs/description-formatting branch May 6, 2026 17:32
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