docs: migrate wiki content to wiki/ folder#48
Merged
Conversation
📝 WalkthroughWalkthroughThis PR adds six documentation files to the ChangesWiki Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 3/10 reviews remaining, refill in 41 minutes and 27 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@wiki/Challenge.md`:
- Line 26: The Markdown link on Line 26 is malformed (contains "L("); update the
link syntax in Challenge.md by replacing the broken fragment
"rinha-de-backend-2024-q1L(" with a proper Markdown link such as
[github.com/zanfranceschi/rinha-de-backend-2024-q1](https://github.com/zanfranceschi/rinha-de-backend-2024-q1.md)
so the URL renders as a clickable link.
In `@wiki/CI-CD-Pipeline.md`:
- Around line 27-29: Update the CI-CD doc text to match the actual deploy.yml
behavior: replace the claim that it directly uses actions/deploy-pages and only
triggers on push with a note that the repo invokes a reusable deployment
workflow (deploy.yml) and that the workflow supports both push to main and
manual runs via workflow_dispatch; also keep the intent to publish the docs/
directory to GitHub Pages but describe that deployment is performed through the
reusable deploy.yml workflow.
In `@wiki/index.md`:
- Around line 11-13: Fix the malformed markdown links by replacing the incorrect
"L(" sequence with the proper closing bracket and paren "](" in the link labels
found (e.g., change "[Getting StartedL(Getting-Started.md)" to "[Getting
Started](Getting-Started.md)" and "[CI/CD PipelineL(CI-CD-Pipeline.md)" to
"[CI/CD Pipeline](CI-CD-Pipeline.md)"); scan the file for other occurrences of
"L(" (such as the "Performance" or any duplicated instances) and correct them so
all link text is enclosed in [] and targets in ().
In `@wiki/Performance.md`:
- Line 22: The markdown link on the line starting with "Load tests are run using
the shared
[rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md)
test suite..." is malformed; update it to use proper markdown link syntax and a
correct URL by replacing the broken token
"[rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md)"
with a well-formed link such as
"[rinha2-back-end-k6](https://github.com/jonathanperis/rinha2-back-end-k6)"
(keep the rest of the sentence unchanged), ensuring the repository name
"rinha2-back-end-k6" is the link text and the URL does not include the stray
".md" or extra characters.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: cc983a87-8e6f-4eee-ae5d-b3d5e42c3545
📒 Files selected for processing (6)
wiki/Architecture.mdwiki/CI-CD-Pipeline.mdwiki/Challenge.mdwiki/Getting-Started.mdwiki/Performance.mdwiki/index.md
|
|
||
| ## Source | ||
|
|
||
| Full specification: [github.com/zanfranceschi/rinha-de-backend-2024-q1L(https://github.com/zanfranceschi/rinha-de-backend-2024-q1.md) |
There was a problem hiding this comment.
Fix broken source link syntax on Line 26.
The link is malformed (L(), so it won’t render as clickable Markdown.
Suggested fix
-Full specification: [github.com/zanfranceschi/rinha-de-backend-2024-q1L(https://github.com/zanfranceschi/rinha-de-backend-2024-q1.md)
+Full specification: [github.com/zanfranceschi/rinha-de-backend-2024-q1](https://github.com/zanfranceschi/rinha-de-backend-2024-q1)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Full specification: [github.com/zanfranceschi/rinha-de-backend-2024-q1L(https://github.com/zanfranceschi/rinha-de-backend-2024-q1.md) | |
| Full specification: [github.com/zanfranceschi/rinha-de-backend-2024-q1](https://github.com/zanfranceschi/rinha-de-backend-2024-q1) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@wiki/Challenge.md` at line 26, The Markdown link on Line 26 is malformed
(contains "L("); update the link syntax in Challenge.md by replacing the broken
fragment "rinha-de-backend-2024-q1L(" with a proper Markdown link such as
[github.com/zanfranceschi/rinha-de-backend-2024-q1](https://github.com/zanfranceschi/rinha-de-backend-2024-q1.md)
so the URL renders as a clickable link.
Comment on lines
+27
to
+29
| - **Trigger:** Push to main branch | ||
| - **Steps:** Deploys the `docs/` directory to GitHub Pages using the actions/deploy-pages workflow | ||
| - **Purpose:** Publish project documentation and stress test reports to GitHub Pages |
There was a problem hiding this comment.
Align deploy workflow description with actual deploy.yml.
Current text says this repo directly uses actions/deploy-pages and only triggers on push, but .github/workflows/deploy.yml uses a reusable workflow and also supports workflow_dispatch.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@wiki/CI-CD-Pipeline.md` around lines 27 - 29, Update the CI-CD doc text to
match the actual deploy.yml behavior: replace the claim that it directly uses
actions/deploy-pages and only triggers on push with a note that the repo invokes
a reusable deployment workflow (deploy.yml) and that the workflow supports both
push to main and manual runs via workflow_dispatch; also keep the intent to
publish the docs/ directory to GitHub Pages but describe that deployment is
performed through the reusable deploy.yml workflow.
Comment on lines
+11
to
+13
| | [Getting StartedL(Getting-Started.md) | Prerequisites and how to run | | ||
| | [Performance](Performance) | Results, benchmarks, resource usage | | ||
| | [CI/CD PipelineL(CI-CD-Pipeline.md) | GitHub Actions workflows | |
There was a problem hiding this comment.
Fix malformed links in the wiki index (navigation is currently broken).
Several links use L( instead of ](, so they won’t render correctly.
Suggested fix
-| [Getting StartedL(Getting-Started.md) | Prerequisites and how to run |
+| [Getting Started](Getting-Started.md) | Prerequisites and how to run |
@@
-| [CI/CD PipelineL(CI-CD-Pipeline.md) | GitHub Actions workflows |
+| [CI/CD Pipeline](CI-CD-Pipeline.md) | GitHub Actions workflows |
@@
-*[GitHubL(https://github.com/jonathanperis/rinha2-back-end-rust.md) · [Jonathan Peris](https://jonathanperis.github.io/)*
+*[GitHub](https://github.com/jonathanperis/rinha2-back-end-rust) · [Jonathan Peris](https://jonathanperis.github.io/)*Also applies to: 24-24
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@wiki/index.md` around lines 11 - 13, Fix the malformed markdown links by
replacing the incorrect "L(" sequence with the proper closing bracket and paren
"](" in the link labels found (e.g., change "[Getting
StartedL(Getting-Started.md)" to "[Getting Started](Getting-Started.md)" and
"[CI/CD PipelineL(CI-CD-Pipeline.md)" to "[CI/CD Pipeline](CI-CD-Pipeline.md)");
scan the file for other occurrences of "L(" (such as the "Performance" or any
duplicated instances) and correct them so all link text is enclosed in [] and
targets in ().
|
|
||
| ## Stress Testing | ||
|
|
||
| Load tests are run using the shared [rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md) test suite, which simulates concurrent users performing debits, credits, validations, and statement queries. |
There was a problem hiding this comment.
Fix broken stress-test suite link on Line 22.
The link is malformed and currently won’t render correctly.
Suggested fix
-Load tests are run using the shared [rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md) test suite, which simulates concurrent users performing debits, credits, validations, and statement queries.
+Load tests are run using the shared [rinha2-back-end-k6](https://github.com/jonathanperis/rinha2-back-end-k6) test suite, which simulates concurrent users performing debits, credits, validations, and statement queries.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Load tests are run using the shared [rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md) test suite, which simulates concurrent users performing debits, credits, validations, and statement queries. | |
| Load tests are run using the shared [rinha2-back-end-k6](https://github.com/jonathanperis/rinha2-back-end-k6) test suite, which simulates concurrent users performing debits, credits, validations, and statement queries. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@wiki/Performance.md` at line 22, The markdown link on the line starting with
"Load tests are run using the shared
[rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md)
test suite..." is malformed; update it to use proper markdown link syntax and a
correct URL by replacing the broken token
"[rinha2-back-end-k6L(https://github.com/jonathanperis/rinha2-back-end-k6.md)"
with a well-formed link such as
"[rinha2-back-end-k6](https://github.com/jonathanperis/rinha2-back-end-k6)"
(keep the rest of the sentence unchanged), ensuring the repository name
"rinha2-back-end-k6" is the link text and the URL does not include the stray
".md" or extra characters.
This was referenced May 3, 2026
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.
Migrate GitHub wiki markdown files to
wiki/folder in main repo. Wiki will be disabled after merge.Summary by CodeRabbit
Documentation