Open
Conversation
|
Bencher Report| Branch | elijah/model-docs-improve |
| Testbed | github-ubuntu-latest |
Click to view all benchmark results
| Benchmark | Latency | Benchmark Result milliseconds (ms) (Result Δ%) | Upper Boundary milliseconds (ms) (Limit %) |
|---|---|---|---|
| empty_router/empty_router | 📈 view plot 🚷 view threshold | 6.41 ms(+5.68%)Baseline: 6.07 ms | 7.37 ms (87.04%) |
| json_api/json_api | 📈 view plot 🚷 view threshold | 1.15 ms(+9.04%)Baseline: 1.06 ms | 1.26 ms (91.71%) |
| nested_routers/nested_routers | 📈 view plot 🚷 view threshold | 1.09 ms(+11.77%)Baseline: 0.97 ms | 1.15 ms (94.82%) |
| single_root_route/single_root_route | 📈 view plot 🚷 view threshold | 1.05 ms(+11.92%)Baseline: 0.94 ms | 1.11 ms (94.14%) |
| single_root_route_burst/single_root_route_burst | 📈 view plot 🚷 view threshold | 17.85 ms(+0.99%)Baseline: 17.68 ms | 21.08 ms (84.68%) |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
Author
|
depends on cot-rs/cot-site#82 and cot-rs/cot-site#84 |
Contributor
Author
|
ElijahAhianyo
commented
Apr 9, 2026
|
|
||
| ``` | ||
|
|
||
| ## Summary |
Contributor
Author
There was a problem hiding this comment.
Some pages have a Summary section while others don't. I'm not too sure which direction we'd want to go, but for the sake of consistency, do we require every page to have a Summary section? I, personally, am not a big fan, but I'm also indifferent if we have them or not
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructure the Docs, starting with the model docs. I've improved the docs to mention a large number of features/functionalities we support. I've also split the docs to span across multiple pages in a subcategory, making it easier and nicer to follow. Currently, we have 2 pages (overview and queries) for Models. The overview section is a bit nuanced as it makes mention of the CotORM, setting up models, and configuring them.
There's also a section of Relationships which I believe deserves its own page once we have the M2M feature implemented(or we can still put this in its own page and show how to do this using an intermediate
throughModel).I would like to add another page for migrations, however, I'm keeping this PR ready at all times for review. Subsequent additions may or may not be included to this PR depending on when this gets merged
Related issue or discussion
Description
Type of change
Checklist
just test-all)just clippy)cargo fmt)