hedera-docs icon indicating copy to clipboard operation
hedera-docs copied to clipboard

Identify missing key terms and link to core concept pages

Open theekrystallee opened this issue 2 years ago • 1 comments

Background Info

While working with Swagger API docs, I ran into the term slots. I couldn’t find any explanation of it in our docs.
Instead I relied on Alchemy docs: https://docs.alchemy.com/docs/smart-contract-storage-layout

Suggested solution

Consider consolidating essential terms within core concept pages while providing concise definitions in the glossary.

Example: “Slots”

Instead of only defining 'Slots' in the glossary, follow Alchemy's way.

Find a main idea that covers 'Slots' well, like Alchemy did with smart contract storage layout. Still, add 'Slots' to the glossary, but also connect it to a bigger picture through a dedicated main idea page for better understanding.

Suggested Action Item(s)

  • [ ] #583
  • [ ] #584
  • [ ] #585
  • [ ] #586

Note: This is a large initiative and cannot be completed in a single sprint; therefore, I recommend if this task gets approved to create smaller attainable tasks that lead to this ultimate goal.

theekrystallee avatar Jan 30 '24 18:01 theekrystallee

This document has a table that presents 3 top concepts that have been identified as important and need to be prioritized for improvement on the docs site based on community feedback. The next steps, are to present at the next docs sync meeting to agree on privatization on which one to get started on first.

https://www.notion.so/swirldslabs/Missing-or-Enhanced-Concepts-for-Consideration-cb6c3b57b5914d0ab3ad158275c53519

a-ridley avatar Mar 09 '24 02:03 a-ridley