Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Add high-level documentation for contributors #115

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

[WIP] Add high-level documentation for contributors #115

wants to merge 14 commits into from

Conversation

charlespwd
Copy link
Collaborator

@charlespwd charlespwd commented Nov 10, 2022 •
edited

This PR is about adding a lot of docs to help folks understand what's going on in the codebase.

It creates the following tree of notes:

  • docs/contributing/index
    • parser
      • ast
      • cst
      • ohmjs
      • stage-1-source-to-cst
      • stage-2-cst-to-ast
      • stage-3-ast-to-augmented-ast
    • printer
      • prettier
        • builders
        • what's a line, softline or hardline?
        • meaningful lack of whitespace handling
    • idempotence
    • learning-tips

Arkham
Arkham reviewed Mar 27, 2023
View reviewed changes
docs/contributing/idempotence.md

## Conclusion

If we want `format(prettyCode) == format(sourceCode)`, then we need to spit out an equivalent AST and our
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this sentence ends midway through :)

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

@Arkham Arkham Arkham left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@charlespwd @Arkham