Create a "Design" section for the LLDB documentation. The goal would be to have design documents that describe how the LLDB internals work. Currently they're mixed together under the "Development" section which hurts discoverability and makes it harder to understand where a new page should go. The existing pages describing the reproducers, the structured data plugins, and the SB API could be housed here but I'd love to see more pages being added here in the future.
Details
Details
- Reviewers
jingham - Group Reviewers
Restricted Project - Commits
- rG128e999d63c4: [lldb] Add a "design" section to the documentation.
Diff Detail
Diff Detail
- Repository
- rG LLVM Github Monorepo
Event Timeline
Comment Actions
What's the difference between design/ and architecture/? These sounds like synonyms to me.
Comment Actions
Good point, that page should be moved under the new section as well. Maybe we should call the section "Architecture" and rename that page to "Overview" when nested underneath?
Comment Actions
I like the name Design better than Architecture for the top level. For instance the structureddataplugins is not really Architecture, it's the design of a fairly small component of lldb
Comment Actions
Architecture is more specific to the structural aspect of a thing, whereas Design is more general. For instance, the rules for the SB API don’t really seem like a description of an Architecture, but more some general principles for doing the thing.
Jim