Skip to content

reorganize site docs#375

Merged
ericbuckley merged 3 commits into
mainfrom
doc/371-reorganize-site-docs
May 16, 2025
Merged

reorganize site docs#375
ericbuckley merged 3 commits into
mainfrom
doc/371-reorganize-site-docs

Conversation

@ericbuckley

@ericbuckley ericbuckley commented May 16, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

Moving existing site docs into new sections to make room for new explanation documentation.

Related Issues

closes #371

Additional Notes

Making the default port used by the local_server.sh script to be 8080, which matches that of our docker setup.

Screenshot of the updated getting started page along with a sidebar view of the new sections.
Screenshot 2025-05-16 at 08-34-52 Getting Started - Record Linker documentation

<--------------------- 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 May 16, 2025
@codecov

codecov Bot commented May 16, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.51%. Comparing base (53408fc) to head (7f4e768).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #375   +/-   ##
=======================================
  Coverage   98.51%   98.51%           
=======================================
  Files          33       33           
  Lines        1948     1948           
=======================================
  Hits         1919     1919           
  Misses         29       29

☔ 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.

@ericbuckley ericbuckley marked this pull request as ready for review May 16, 2025 15:38
johanna-skylight
johanna-skylight approved these changes May 16, 2025
View reviewed changes

@johanna-skylight johanna-skylight 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.

LGTM!

@ericbuckley ericbuckley merged commit 210f706 into main May 16, 2025
17 checks passed
@ericbuckley ericbuckley deleted the doc/371-reorganize-site-docs branch May 16, 2025 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@johanna-skylight johanna-skylight johanna-skylight approved these changes

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

@m-goggins m-goggins Awaiting requested review from m-goggins m-goggins is a code owner

Assignees

@ericbuckley ericbuckley

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Tech Docs: re-organize

2 participants

@ericbuckley @johanna-skylight