Conversation
| @@ -0,0 +1,479 @@ | |||
| = Couchbase Glossary | |||
There was a problem hiding this comment.
AsciiDoc apparently has a markup that's designed for glossaries — see Glossary. But it's not clear to me what the benefit of the [glossary] style is or why we would want to apply it. It may be useful if we want to apply specific styling just to the glossary. If that's not necessary we probably don't need it.
There was a problem hiding this comment.
I'm not sure if we have anything that takes advantage of that markup, or if the "book" features are even heavily used in our docs set now? Might be worth a look, might be worth considering, I'm just not sure we're set up for it right now.
| ACID stands for Atomicity, Consistency, Isolation, and Durability. | ||
| Couchbase supports ACID transactions across multiple documents. | ||
|
|
||
| *Adaptive Index*:: An index type that adjusts its structure based on query patterns and data distribution, providing flexibility for evolving workloads. |
There was a problem hiding this comment.
💡 idea! Can we have anchors for each glossary term so that we can link to them from other parts of the documentation?
There was a problem hiding this comment.
Yes, agree we should do this!
(Probably easiest to do as a single post-process, once the list is agreed, to give the LLM less to worry about)
There was a problem hiding this comment.
Yup would love to do this.
Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>
I've committed your suggestions for now - please make sure to come back and add links to further explanations! |
rakhi-prathap
left a comment
rakhi-prathap
left a comment
There was a problem hiding this comment.
@sarahlwelton - Looking at the A-Z Word List, I'm wondering if we could try a similar layout for the glossary too. It seems more readable and easy to scan. Just a thought for later!
Good idea! Definitely something we can see about getting set up, if we want to move away from the classic description list format - this was just AI's first attempt at formatting :) @simon-dew , if we do that, I'm not sure that we'd be able to take advantage of the |
4 participants
Creating glossary.adoc.
Exact location in nav TBD, pending review from entire team + stakeholders.