Skip to content

Conversation

lbv-stripe
Copy link
Contributor

@lbv-stripe lbv-stripe commented Oct 31, 2022

Right now, we've got two related problems:

  1. The IA implies that /docs/attributes is the most detailed source on attributes — but some attribute info is only in /docs/syntax, making the whole story hard to find
  2. The structure of /docs/syntax implies that annotations are a separate feature — but there's no /docs/annotations, making the whole story hard to find

This PR addresses those by pushing most attribute and annotation info into /docs/attributes, and by adding language that clarifies that annotations are just an alternate syntax for passing attributes.

Base automatically changed from lbv/content-within-pages to main October 31, 2022 16:17
Copy link
Contributor

@mfix-stripe mfix-stripe left a comment

Choose a reason for hiding this comment

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

r? @lbv-stripe can you rebase this on main now that we have merged your other PR so that the diff is clearer? Thanks!

@vercel
Copy link

vercel bot commented Oct 31, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
markdoc ✅ Ready (Inspect) Visit Preview Oct 31, 2022 at 5:53PM (UTC)
markdoc-simple-nextjs ✅ Ready (Inspect) Visit Preview Oct 31, 2022 at 5:53PM (UTC)

@mfix-stripe
Copy link
Contributor

Closing in favor of #99

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