document features

[jorgeorpinel]

Document in the README:

• Glossary tooltips <abbr>
• sidebar.json schema & options (auto-capitals/auto-lowers, external entries, ...)
• Admonitions <admon> or <admonition>: usage and note Minor fixes dvc.org#3422 (comment)
• <cards> with <card>(?): (only used in https://dvc.org/doc I think)
• Expandable sections <details>
• Tab toggles <toggle> + <tab>: usage
• Supported languages? (usage, cli|dvc|cml|mlem, dvctable highlighters) - see prism: we need both dvc and mlem highlighters mlem.ai#59
• Auto-linking (setup, special cases, etc.)
• delete most of https://dvc.org/doc/contributing/docs in favour of a backlink to the README here

Also really should document docs features as we implement them, even if it's just one line (or at least open follow-up issues to track).

Moved from iterative/dvc.org#3506 @casperdcl

[casperdcl]

updated description :)

[julieg18]

Discussed this with Ivan, and while documenting features in this repo would be better than dvc.org since all our sites are using doc features, adding them to README would force us to rely on screenshots or similar for examples of the actual components.

Ivan had the idea that we deploy the example website in this repo and document the doc engine features in the docs examples :) The example site would need to be cleaned up a bit, but our doc-engine documentation would be a lot more readable and pr testing would be easier as well.

@rogermparent, @yathomasi, what do you think?

[yathomasi]

Ivan had the idea that we deploy the example website in this repo and document the doc engine features in the docs examples :)

That's really great idea. We can move ahead and deploy the example website and start collaborating with the @iterative/docs team. We can update the landing page with a welcome screen for contributors and add a call to action linking with docs.

[rogermparent]

Seconded for deploying the example website! I had intended for it to happen eventually, but just hadn't done it yet. A page per feature on the example's docs content would be the perfect way to handle many concerns in one elegant package!

[jorgeorpinel]

There's an example website? 😃 the def. let's use our docs to doc our docs!

[casperdcl]

🐕 🥫 #30