docs: fix typos and repeated words - #15620
Open
toyeshhm wants to merge 2 commits into
Open
Conversation
Fourteen corrections across the docs. Spelling: `occured`, `programing`, `sucessfully`, `instuct`, `labled`, `propriatry`, `satified`, `crated`, and `PostgresSQL` -> `PostgreSQL` (spelled correctly in the other 80 places it appears). Repeated words: "advised to to use", "contains the the expected", "of the the user message", "has the the following sections", "navigates to to a login screen". Left the two "and AND-combined" hits in the release notes alone; those are correct as written.
dosubot
Bot
added
the
size:S
Contributor
|
I have read the CLA Document and I hereby sign the CLA 1 out of 2 committers have signed the CLA. |
There was a problem hiding this comment.
Pull request overview
This PR improves the quality and professionalism of Phoenix documentation by fixing typos and repeated words across multiple MDX pages.
Changes:
- Corrects multiple spelling mistakes in documentation pages.
- Removes several duplicated words/phrases (e.g., “to to”, “the the”) to improve readability.
- Standardizes “PostgreSQL” spelling in the self-hosting configuration docs.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/phoenix/tracing/tutorial/annotations-and-evaluations.mdx | Fixes a spelling error (“satisfied”). |
| docs/phoenix/tracing/how-to-tracing/setup-tracing/setup-sessions.mdx | Fixes a spelling error in a code comment (“created”). |
| docs/phoenix/self-hosting/features/authentication.mdx | Removes duplicated “to” in a sentence about login navigation. |
| docs/phoenix/self-hosting/configuration.mdx | Removes duplicated “to” and fixes “PostgresSQL” → “PostgreSQL” in DB configuration docs. |
| docs/phoenix/resources/phoenix-to-arize-ax-migration.mdx | Fixes “occured” → “occurred”. |
| docs/phoenix/prompt-engineering/overview-prompts/prompts-in-code.mdx | Fixes “propriatry” → “proprietary”. |
| docs/phoenix/integrations/evaluation-integrations/uqlm.mdx | Fixes “sucessfully” → “successfully”. |
| docs/phoenix/datasets-and-experiments/concepts-datasets.mdx | Removes duplicated “the the” in dataset concepts text. |
| docs/phoenix/cookbook/tracing/structured-data-extraction.mdx | Removes duplicated “the the” in a checklist item. |
| docs/phoenix/cookbook/tracing/identify-high-signal-traces.mdx | Fixes “programing” → “programming”. |
| docs/phoenix/cookbook/evaluation/evaluate-rag.mdx | Removes duplicated “the the” in the section introduction. |
| docs/phoenix/cookbook/evaluation/evaluate-an-agent.mdx | Fixes “labled” → “labeled”. |
| docs/phoenix/cookbook/datasets-and-experiments/summarization.mdx | Fixes “instuct” → “instruct” in an example snippet. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| * **PHOENIX\_ALLOW\_EXTERNAL\_RESOURCES:** Controls whether external resources (such as Google Fonts) are loaded in the web interface. Defaults to `true`. Set to `false` in air-gapped environments to prevent external requests that can cause UI loading delays. Available since version 11.15.0. | ||
|
|
||
| * **PHOENIX\_SQL\_DATABASE\_URL:** The SQL database URL to use when logging traces and evals. if you plan on using SQLite, it's advised to to use a persistent volume and simply point the `PHOENIX_WORKING_DIR` to that volume. If URL is not specified, by default Phoenix starts with a file-based SQLite database in a temporary folder, the location of which will be shown at startup. Phoenix also supports PostgresSQL as shown below: | ||
| * **PHOENIX\_SQL\_DATABASE\_URL:** The SQL database URL to use when logging traces and evals. if you plan on using SQLite, it's advised to use a persistent volume and simply point the `PHOENIX_WORKING_DIR` to that volume. If URL is not specified, by default Phoenix starts with a file-based SQLite database in a temporary folder, the location of which will be shown at startup. Phoenix also supports PostgreSQL as shown below: |
| <table data-header-hidden data-full-width="false"><thead><tr><th width="300">Variable</th><th>Description</th></tr></thead><tbody><tr><td><strong>PHOENIX_USE_SECURE_COOKIES</strong></td><td>If set to <strong>True</strong>, access and refresh tokens will be stored in secure cookies. Defaults to <strong>False</strong>.</td></tr><tr><td><strong>PHOENIX_CSRF_TRUSTED_ORIGINS</strong></td><td>A comma-separated list of origins allowed to bypass Cross-Site Request Forgery (CSRF) protection. This setting is recommended when configuring OAuth2 clients or sending password reset emails. If this variable is left unspecified or contains no origins, CSRF protection will not be enabled. In such cases, when a request includes <code>origin</code> or <code>referer</code> headers, those values will not be validated.</td></tr></tbody></table> | ||
|
|
||
| Deploy Phoenix with the above environment variables set. You will know that you have setup authentication correctly if the UI navigates to to a login screen. | ||
| Deploy Phoenix with the above environment variables set. You will know that you have setup authentication correctly if the UI navigates to a login screen. |
| You can use phoenix spans and traces to inspect the invocation parameters of the function to | ||
|
|
||
| 1. verify the inputs to the model in form of the the user message | ||
| 1. verify the inputs to the model in form of the user message |
| ## Function Calling Evals using Ground Truth | ||
|
|
||
| The above example works, however if you have ground truth labled data, you can use that data to get an even more accurate measure of your router's performance by running an experiments. | ||
| The above example works, however if you have ground truth labeled data, you can use that data to get an even more accurate measure of your router's performance by running an experiments. |
Collaborator
|
thanks @toyeshhm - we require a CLA signing. We'll get it merged in when ci is clear. |
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
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.
Fourteen corrections across the documentation.
Spelling —
occured,programing,sucessfully,instuct,labled,propriatry,satified,crated, andPostgresSQLon the self-hosting configuration page (spelledPostgreSQLin the other 80 places it appears in the docs).Repeated words — five of these:
self-hosting/configuration.mdx— "it's advised to to use a persistent volume"datasets-and-experiments/concepts-datasets.mdx— "often contains the the expected LLM application output"cookbook/tracing/structured-data-extraction.mdx— "in form of the the user message"cookbook/evaluation/evaluate-rag.mdx— "It has the the following sections"self-hosting/features/authentication.mdx— "the UI navigates to to a login screen"I left the two "and AND-combined" phrases in the release notes as they are, since those read correctly.