Repository navigation
docs: Start a compiler development guide outside the main table of contents - #17120
Merged
Merged
Conversation
Contributor
Author
|
@cameel cc |
Collaborator
|
Also CC @clonker. This would be the place for our implementation docs. |
cameel
reviewed
Oct 19, 2026
…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. Sphinx has one index for the whole documentation, so the page is indexed under a specific subentry, ethdebug; internal debug info, rather than as a main entry for ethdebug and debug info.
djolertrk
force-pushed
the
docs/compiler-guide
branch
from
October 19, 2026 15:26
f676e62 to
61c31d7
Compare
cameel
approved these changes
Oct 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.rstmoves there fromdocs/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.