Skip to content

docs: Start a compiler development guide outside the main table of contents - #17120

Open
djolertrk wants to merge 1 commit into
argotorg:developfrom
walnuthq:docs/compiler-guide
Open

djolertrk wants to merge 1 commit into
argotorg:developfrom
walnuthq:docs/compiler-guide

Conversation

@djolertrk

Copy link
Copy Markdown
Contributor

Adds docs/compiler-guide/ for pages aimed at compiler developers, with its own table of contents titled "Solidity Compiler Development Guide". The main table of contents does not link it.

ethdebug_internal_debug_info.rst moves there from docs/internals/ under a new "Implementation plans" category. Its index entries are removed: Sphinx builds a single index for the whole documentation, so they would show up next to the user-facing pages.

Split out of #16990 as suggested in the review. That PR adds a second category, "Feature guides", with the ethdebug implementation page.

…ntents

Add a separate table of contents for pages aimed at compiler developers,
which the main one does not link, and move the specification of the
ethdebug internal debug info there under the implementation plans. Its
index entries are dropped, since Sphinx has one index for the whole
documentation and they would show up next to the user-facing pages.
@djolertrk

Copy link
Copy Markdown
Contributor Author

@cameel cc

@cameel

cameel commented Oct 15, 2026

Copy link
Copy Markdown
Collaborator

Also CC @clonker. This would be the place for our implementation docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants