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.

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

Write implementation documentation #2042

Merged
merged 5 commits into from
Nov 3, 2023
Merged

Write implementation documentation #2042

merged 5 commits into from
Nov 3, 2023

Conversation

nex3
Copy link
Contributor

@nex3 nex3 commented Jul 21, 2023

Also rename Dispatcher to CompilationDispatcher for clarity

Also rename Dispatcher to CompilationDispatcher for clarity
@nex3 nex3 changed the title Start writing implementation documentation Write implementation documentation Jul 21, 2023
Copy link
Contributor

@stof stof left a comment

Choose a reason for hiding this comment

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

This documentation is quite useful. I would have loved to have it 2 years ago when I started studying the dart-sass source code instead of having to figure everything by myself (while learning dart at the same time).

lib/src/README.md Outdated Show resolved Hide resolved
lib/src/README.md Outdated Show resolved Hide resolved
lib/src/README.md Outdated Show resolved Hide resolved
lib/src/README.md Outdated Show resolved Hide resolved
lib/src/parse/README.md Outdated Show resolved Hide resolved
lib/src/js/README.md Outdated Show resolved Hide resolved
lib/src/ast/css/README.md Outdated Show resolved Hide resolved
lib/src/js/README.md Outdated Show resolved Hide resolved
lib/src/js/README.md Outdated Show resolved Hide resolved
@stof
Copy link
Contributor

stof commented Nov 2, 2023

@nex3 I would suggest merging this so that the documentation is in the repo (and future PRs might update it if needed)

@nex3
Copy link
Contributor Author

nex3 commented Nov 3, 2023

I'm hoping @pamelalozano16 has another chance to review.

@nex3 nex3 merged commit dd56d28 into main Nov 3, 2023
44 checks passed
@nex3 nex3 deleted the impl-docs branch November 3, 2023 23:09
jgerigmeyer added a commit to oddbird/dart-sass that referenced this pull request Nov 17, 2023
* feature.color-4:
  Poke CI
  Update link to Node.js releases page (sass#2131)
  Write implementation documentation (sass#2042)
  Remove dead code (sass#2129)
  Add compatibility with Node.js 21.0.0 (sass#2128)
  Bump lints from 2.1.1 to 3.0.0 (sass#2126)
  Bump dartdoc from 6.3.0 to 7.0.0 (sass#2118)
  Cut a release (sass#2120)
  Update pubspec and changelog for sass/embedded-host-node#257 (sass#2116)
  Fix crash in browser when running alongside NextJS (sass#2114)
  Cut another release (sass#2111)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants