Skip to content

design explanations#451

Merged
ericbuckley merged 10 commits into
mainfrom
doc/372-design-explanations
Jul 7, 2025
Merged

design explanations#451
ericbuckley merged 10 commits into
mainfrom
doc/372-design-explanations

Conversation

@ericbuckley

@ericbuckley ericbuckley commented Jun 26, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

Split site design document into schema and algorithm

Related Issues

#closes #372

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@ericbuckley ericbuckley self-assigned this Jun 26, 2025
@ericbuckley ericbuckley added the documentation Improvements or additions to documentation label Jun 26, 2025
@ericbuckley ericbuckley marked this pull request as ready for review June 26, 2025 18:19
@codecov

codecov Bot commented Jun 26, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.44%. Comparing base (a2c36d7) to head (d9d0e07).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #451   +/-   ##
=======================================
  Coverage   98.44%   98.44%           
=======================================
  Files          41       41           
  Lines        2318     2318           
=======================================
  Hits         2282     2282           
  Misses         36       36

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

m-goggins
m-goggins approved these changes Jul 3, 2025
View reviewed changes

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looking good! I left only a few small suggestions but I like that you broke out algo-guide.

Comment thread docs/site/schema-design.md Outdated
Comment thread docs/site/schema-design.md Outdated
Comment thread docs/site/schema-design.md
@ericbuckley @m-goggins
Update docs/site/schema-design.md
ebffdcf 
Co-authored-by: Marcelle <53578688+m-goggins@users.noreply.github.com>
ericbuckley
ericbuckley commented Jul 7, 2025
View reviewed changes
Comment thread docs/site/schema-design.md Outdated
@ericbuckley ericbuckley merged commit a4a3a91 into main Jul 7, 2025
13 checks passed
@ericbuckley ericbuckley deleted the doc/372-design-explanations branch July 7, 2025 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@m-goggins m-goggins m-goggins approved these changes

@bamader bamader Awaiting requested review from bamader bamader is a code owner

Assignees

@ericbuckley ericbuckley

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Tech Docs: design explanations

2 participants

@ericbuckley @m-goggins