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

docs: update existing markdown documentation and add architecture overview #830

Merged
merged 6 commits into from
Jan 31, 2025

Conversation

HBobertz
Copy link
Contributor

@HBobertz HBobertz commented Jan 29, 2025

Updating the markdown documentation to better describe the architecture of the project and how to use it

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@HBobertz HBobertz changed the title docs: add architecture.md and update readme docs: add ARCHITECTURE.md and update the readme and contributing guides Jan 29, 2025
@HBobertz HBobertz changed the title docs: add ARCHITECTURE.md and update the readme and contributing guides docs: update the readme, contributing, and architecture markdown files Jan 29, 2025
@HBobertz HBobertz changed the title docs: update the readme, contributing, and architecture markdown files docs: update existing markdown documentation and add architecture overview Jan 29, 2025
@HBobertz HBobertz marked this pull request as ready for review January 30, 2025 15:06
@cdklabs-automation cdklabs-automation added this pull request to the merge queue Jan 31, 2025
Merged via the queue into main with commit c346901 Jan 31, 2025
10 checks passed
@cdklabs-automation cdklabs-automation deleted the bobertzh/readmes branch January 31, 2025 10:14
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.9%. Comparing base (6d8f048) to head (d4cbf4a).
Report is 9 commits behind head on main.

Additional details and impacted files
Components Coverage Δ
Parser 87.2% <ø> (ø)
Intermediate Representation 93.9% <ø> (ø)
Synthesizers 95.8% <ø> (ø)
Other 25.6% <ø> (ø)
@@          Coverage Diff          @@
##            main    #830   +/-   ##
=====================================
  Coverage   90.9%   90.9%           
=====================================
  Files         25      25           
  Lines       5089    5089           
  Branches    5089    5089           
=====================================
  Hits        4625    4625           
  Misses       464     464           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d8f048...d4cbf4a. Read the comment docs.

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.

3 participants