This is an archive of the discontinued LLVM Phabricator instance.

[lldb] Simplify the LLDB website structure
ClosedPublic

Authored by JDevlieghere on Aug 15 2023, 2:31 PM.

Details

Reviewers
fdeazeve
bulbazord
Group Reviewers
Restricted Project
Commits
rG3e3880e370c8: [lldb] Simplify the LLDB website structure
Summary

Feedback I hear regularly is that the LLDB website is hard to navigate. This patch is an attempt to simplify things by breaking the website up in 3 major areas: using LLDB, extending LLDB and developing LLDB.

Concretely:

  • The majority of the "project" pages were eliminated, with the exception of the projects page, which was moved under "Developing LLDB". The goals, features and status page were pretty outdated and while they probably made sense in the past, they don't feel all that relevant anymore now that LLDB is an established debugger. The releases page was replaced with a link under "External links".
  • "USE & EXTENSION" was renamed to "Using LLDB". Besides that this section remained mostly unchanged, with the exception of the Python pages which were moved under "Extending LLDB".
  • "Development" was renamed to "Developing LLDB" and now houses all the resources for LLDB developers. The old "Design" section (which only contained two pages) was moved back under here too.

Diff Detail

Event Timeline

JDevlieghere created this revision.Aug 15 2023, 2:31 PM
Herald added a project: Restricted Project. · View Herald TranscriptAug 15 2023, 2:31 PM
Herald added a subscriber: arphaman. · View Herald Transcript
JDevlieghere requested review of this revision.Aug 15 2023, 2:31 PM

I think the categories you've set are the same ones I would have created. May I suggest renaming Extending LLDB to Scripting LLDB or something similar? I think "Extending" and "Developing" are close enough in meaning that it may be confusing to end users.

fdeazeve added a subscriber: fdeazeve.EditedAug 16 2023, 4:36 AM

I think the categories you've set are the same ones I would have created. May I suggest renaming Extending LLDB to Scripting LLDB or something similar? I think "Extending" and "Developing" are close enough in meaning that it may be confusing to end users.

+1 to scripting; this is the word we use all the time, so it makes sense to highlight it as the name of a category.

Btw, what do you think of the "DWARF Extensions supported by LLDB" page? This patch currently keeps that page under "using lldb", but if we read that page it contains no "using" information. It explains at length how an extension is *implemented* in terms of DWARF. Because of that, I think the page is aimed at LLDB developers.

  • Rename "Extending LLDB" to "Scripting LLDB".
  • Move "DWARF Extensions" to the developer section.
fdeazeve accepted this revision.Aug 17 2023, 4:39 PM

LGTM!

This revision is now accepted and ready to land.Aug 17 2023, 4:39 PM
bulbazord accepted this revision.Aug 17 2023, 5:31 PM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptAug 18 2023, 11:20 AM
lldb/docs/status/features.rst