Skip to content

Update docs#120

Merged
akrakauer merged 8 commits into
mainfrom
update-docs
May 19, 2026
Merged

Update docs#120
akrakauer merged 8 commits into
mainfrom
update-docs

Conversation

@akrakauer
Copy link
Copy Markdown
Collaborator

Docs updated to reflect new approach of the system.

Previously merged the branch that removes postgres from pull request #115 into this one to get updated docs, so that pr should probably be reviewed separately and merged before this one.

@akrakauer akrakauer self-assigned this May 19, 2026
@akrakauer akrakauer added the documentation Improvements or additions to documentation label May 19, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 19, 2026

Test And Coverage Report

Job status: ✅ success

Test Status

Metric Value Status
Total tests 130 -
Passed 130
Failed 0
Errors 0
Skipped 0
Total test duration (s) 18.08 -

Coverage Status

Metric Value Status
Instruction coverage 67.09%
Branch coverage 53.93%
Line coverage 66.70%

Coverage thresholds: ✅ >= 85%, 🟡 70% to 84.99%, ❌ < 70%

@akrakauer akrakauer marked this pull request as draft May 19, 2026 00:47
@akrakauer akrakauer marked this pull request as ready for review May 19, 2026 01:10
@akrakauer akrakauer requested a review from a team May 19, 2026 01:10
@akrakauer
Copy link
Copy Markdown
Collaborator Author

akrakauer commented May 19, 2026

Ignore all the files that aren't md files (the ones in the docs folder and the repo README), those have been merged already in a different pr and weren't actually changed here, they are just from rebasing from that branch.

Copy link
Copy Markdown
Collaborator

@NoamBenS NoamBenS left a comment

Choose a reason for hiding this comment

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

I think merging into this and then remerging into main was a really bad decision. that being said i dont think it's worth the time to undo that, and the docs themselves are fine.

Copy link
Copy Markdown
Collaborator

@MaxFdev MaxFdev left a comment

Choose a reason for hiding this comment

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

👍

@akrakauer akrakauer merged commit aece8cf into main May 19, 2026
2 checks passed
@akrakauer akrakauer deleted the update-docs branch May 19, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix usage and installation docs to include instructions for client Create API docs

3 participants