📝 Added known issues page and timeout bug info #606
Conversation
WalkthroughA new "Known Issues" documentation page was created, listing known bugs and configuration issues for various components, with most sections stating no current issues. The Vitepress documentation site's navigation was updated to include links to this page in both the top navigation bar and a new Support sidebar section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
Type: Bug
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/.vitepress/config.mts (2)
39-40: Consider moving “Known Issues” out of the “Docs” dropdownThe target path lives under
/support/*, so lumping it into the Docs group feels semantically off. A dedicated top-level nav item (e.g.{ text: "Support", link: "/support/known-issues" }) would make the IA clearer and avoid coupling support content with product docs.Example diff:
- { - text: "Docs", + { + text: "Docs", items: [ @@ - { text: "OpenAPI", link: "/cross-cutting-concepts/openapi" }, - { text: "Known Issues", link: "/support/known-issues" }, + { text: "OpenAPI", link: "/cross-cutting-concepts/openapi" }, ], }, + { text: "Support", link: "/support/known-issues" },
93-101: Add alinkto the “Support” sidebar group for one-click accessGroups without a
linkrender as non-clickable headings. Supplying the same page path gives users a quick entry point.- { - text: "Support", - items: [ + { + text: "Support", + link: "/support/known-issues", + items: [docs/support/known-issues.md (1)
30-35: Correct typos and unify spellingSmall language fixes improve professionalism.
-#### Timeout on SSO misconfiguration or audience claim mismatch -When the configured SSO URLs in the `refarch-backend` and API gateway do not match, trying to access a secured endpoint in the backend via the API gateway results in a timout. -The same behaviour occurs when the names of the expected audience claims do not match. +#### Timeout on SSO misconfiguration or audience claim mismatch +When the configured SSO URLs in the `refarch-backend` and API gateway do not match, accessing a secured endpoint in the backend via the API gateway results in a timeout. +The same behavior occurs when the names of the expected audience claims do not match.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/.vitepress/config.mts(2 hunks)docs/support/known-issues.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/support/known-issues.md
[style] ~6-~6: Consider using a different verb to strengthen your wording.
Context: ...e provide. ::: info Information If you found an issue not mentioned here, please hea...
(FIND_ENCOUNTER)
[grammar] ~32-~32: Ensure spelling is correct
Context: ...ackend via the API gateway results in a timout. The same behaviour occurs when the nam...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/support/known-issues.md (4)
3-3: Grammar: streamline wording for clarityThe phrase “different artifacts and templates we provide” is a bit clunky. A more concise construction improves readability.
-This page informs about known issues or bugs in the different artifacts and templates we provide. +This page lists known issues and bugs affecting the various artifacts and templates we provide.
5-8: Tighten admonition wording & punctuation
- Use present-tense “find” instead of past “found”.
- Add comma after “If not” to avoid a run-on sentence.
- The admonition header can be shortened; “Info” is implicit.
-::: info Information -If you found an issue not mentioned here, please head over to our GitHub repositories and check if a corresponding bug ticket exists. -If not feel free to open a new one. +::: info +If you find an issue not mentioned here, please check our GitHub repositories for an existing bug ticket. +If not, feel free to open a new one.
10-28: Consistent heading capitalisationAdopt title-case headings throughout for polish and consistency (“API Gateway”, “Integrations”, etc.).
-## API gateway +## API Gateway @@ -### refarch-frontend +### refarch-frontend @@ -### refarch-webcomponent +### refarch-webcomponent @@ -### refarch-backend +### refarch-backend @@ -### refarch-eai +### refarch-eai(You may decide to capitalise the template names as proper nouns as well, e.g., “RefArch-Frontend”.)
32-36: Minor wording & hyphen fixHyphenating “configuration-error” is unnecessary, and “real-case scenario” can be simplified.
-In both cases this is a configuration-error and thus should not occur in a working real-case scenario. +Both cases are configuration errors and should not occur in a properly configured production environment.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/.vitepress/config.mts(2 hunks)docs/support/known-issues.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/.vitepress/config.mts
🧰 Additional context used
🪛 LanguageTool
docs/support/known-issues.md
[style] ~6-~6: Consider using a different verb to strengthen your wording.
Context: ...e provide. ::: info Information If you found an issue not mentioned here, please hea...
(FIND_ENCOUNTER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-maven
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/support/known-issues.md (3)
3-3: Refine wording for clarityThe phrase “the different artifacts and templates we provide” reads a bit awkwardly. Re-phrasing slightly improves flow.
-This page informs about known issues or bugs in the different artifacts and templates we provide. +This page lists known issues and bugs affecting the various artifacts and templates that we provide.
5-8: Tighten grammar in the information call-outA couple of minor language nits: use present-tense “find”, add a comma after “If not”, and replace “head over” with a more neutral verb.
-If you found an issue not mentioned here, please head over to our GitHub repositories and check if a corresponding bug ticket exists. -If not feel free to open a new one. +If you find an issue that is not mentioned here, please visit our GitHub repositories and check whether a corresponding bug ticket already exists. +If not, feel free to open a new one.
18-18: Fix hyphenation and wording“configuration-error” should not be hyphenated, and “real-case” is uncommon.
-In both cases this is a configuration-error and thus should not occur in a working real-case scenario. +In both cases, this is a configuration error and therefore should not occur in a correctly configured production scenario.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/support/known-issues.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/support/known-issues.md
[style] ~6-~6: Consider using a different verb to strengthen your wording.
Context: ...e provide. ::: info Information If you found an issue not mentioned here, please hea...
(FIND_ENCOUNTER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-maven
🔇 Additional comments (1)
docs/support/known-issues.md (1)
14-16: Verify internal links resolve correctlyBoth links (
/gateway#securityand/cross-cutting-concepts/security#client-validation) rely on section anchors. Please double-check that:
- The target markdown files exist at those paths in the built site.
- The exact heading IDs match the anchors used here (case-sensitive in VitePress).
Broken anchors will silently drop users at the top of the page.
Pull Request
Changes
Reference
Issue: #598
Checklist
Note: If some checklist items are not relevant for your PR, just remove them.
General
I have read the Contribution Guidelines (TBD)Summary by CodeRabbit