Skip to content

Links from Debugger courseware to Sleigh documentation are broken in distribution (derived from #8608) #8699

@nsadeveloper789

Description

@nsadeveloper789

Describe the bug
Links from the DebuggerCourse, e.g., in docs/GhidraClass/Debugger/A4-MachineState.html#sleigh-expressions are broken in the distribution. As discussed in #8608, the links use paths as found in the source repo. While they work there, arguably, they should be prioritized in the actual distribution.

To Reproduce
Steps to reproduce the behavior:

  1. Open the above file in a browser.
  2. Click on any of the links referencing the p-code documentation
  3. See the breakage

Expected behavior
The links should be consistent. Ideally, they'd work in both the source repo and the distribution. More ideally, source forms should refer to other source forms (esp., in the case of Markdown, as these are designed to be rendered by GitHub), and distribution forms (i.e., HTML) should refer to the corresponding distribution forms. Accomplishing this will probably require some link/path transformation in the Markdown rendering process. We use Pandoc, which permits Lua-based transformations, so this should be doable.

Metadata

Metadata

Labels

Status: InternalThis is being tracked internally by the Ghidra teamType: BugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions