docs: update links for local evaluation and edge proxy docs#7961
Conversation
|
@nattiechan is attempting to deploy a commit to the Flagsmith Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis pull request updates documentation link targets from an older integration-overview URL structure to SDK-specific anchors for Local Evaluation Mode and Environment Document references across several docs pages. It also adds new Edge Proxy Estimated code review effort: 2 (Simple) | ~15 minutes Changes
Sequence Diagram(s)Not applicable — this PR consists of documentation link/content updates and regenerated API reference schemas with no observable runtime interaction flow. Related issues: None specified. Related PRs: None specified. Suggested labels: documentation Suggested reviewers: None specified. Comment |
The current link does not link to relevant content, so this commit fixes the issue
- Add default info to `api_url` config - Add more info on identity override troubleshooting
Update the links to local evaluation mode to be more specific depending on the context
There is a more comprehensive link in SDK overview, so using that one instead
nattiechan
force-pushed
the
docs/edge-proxy-improvements
branch
from
0a9a01e to
5dad1e3
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 9f45b787-8937-428e-85c2-af8abc9a2a9f
📒 Files selected for processing (15)
docs/docs/administration-and-security/billing-api-usage.mddocs/docs/administration-and-security/governance-and-compliance/api-usage.mddocs/docs/best-practices/defensive-coding.mddocs/docs/best-practices/efficient-api-usage.mddocs/docs/deployment-self-hosting/edge-proxy.mddocs/docs/getting-started/glossary.mddocs/docs/integrating-with-flagsmith/sdks/index.mddocs/docs/performance/edge-proxy.mddocs/docs/sdk-api/flagsmith-api.info.mdxdocs/docs/sdk-api/sdk-v-1-environment-document.api.mdxdocs/docs/sdk-api/sdk-v-1-flags.api.mdxdocs/docs/sdk-api/sdk-v-1-get-identities.api.mdxdocs/docs/sdk-api/sdk-v-1-post-identities.api.mdxdocs/docs/sdk-api/sdk.tag.mdxdocs/docs/sdk-api/sidebar.ts
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: d10c31f1-548e-46db-90cc-06ec405d61aa
📒 Files selected for processing (15)
docs/docs/administration-and-security/billing-api-usage.mddocs/docs/administration-and-security/governance-and-compliance/api-usage.mddocs/docs/best-practices/defensive-coding.mddocs/docs/best-practices/efficient-api-usage.mddocs/docs/deployment-self-hosting/edge-proxy.mddocs/docs/getting-started/glossary.mddocs/docs/integrating-with-flagsmith/sdks/index.mddocs/docs/performance/edge-proxy.mddocs/docs/sdk-api/flagsmith-api.info.mdxdocs/docs/sdk-api/sdk-v-1-environment-document.api.mdxdocs/docs/sdk-api/sdk-v-1-flags.api.mdxdocs/docs/sdk-api/sdk-v-1-get-identities.api.mdxdocs/docs/sdk-api/sdk-v-1-post-identities.api.mdxdocs/docs/sdk-api/sdk.tag.mdxdocs/docs/sdk-api/sidebar.ts
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
2 participants
Thanks for submitting a PR! Please check the boxes below:
docs/if required so people know about the feature.Changes
Based on my experience implementing Flagsmith Client SDK, and Server SDK via edge proxy, I decided to update some of the documentation around local evaluation and edge proxy to clear up some confusion I had during the implementation. The contribution stemmed from this discord message: https://discord.com/channels/517647859495993347/917719343930957846/1521555745798226093
I also updated the openAPI docs accordingly per
READMEin/docs, though unsure if I have done it correctly.How did you test this code?
Ran server locally via
make serveto visualize the changes locally.