Sketch out documentation structure #650
Merged
Conversation
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.
I would like to begin a process of updating the LLVM backend's documentation; it is now a large enough project with enough different people working on it that the code is no longer a good enough reference for how everything works, especially now that we have new compiler engineers coming online.
With that in mind, this PR proposes a rough structure for a technical reference for the backend. I have intentionally not written any documentation; I would first like to get feedback on the structure and topics here.
@dwightguth @theo25 @gtrepta please let me know if there are any topics I've missed off here, or if you think I should add anything to the list. I would like to hear from you all even if you don't have anything to add to the list, just to make sure that it's as complete as can be.
Once we have a consensus on the structure and topics, I propose we merge this list of bulletpoints, and individual topics can be written up gradually in smaller PRs.
Works towards #621