docs(quarto): Tidy up & address Quarto-rendered formatting for first Pages deployment#148
Draft
lukeroantreeONS wants to merge 6 commits intomainfrom
Draft
Conversation
…sheet - rows 11-14 (note, some issues not addressed)
rileyok-ons
requested changes
Mar 11, 2026
Collaborator
rileyok-ons
left a comment
rileyok-ons
left a comment
There was a problem hiding this comment.
Changes mainly look much better, got a few updates to the servers and got a formatting issue with the new preprocessing hook table
| "\n", | ||
| "The reverse_search() and embed() VectorStore functions have their own input and output data classes with their own validity column data checks. The names of each set are intuitively:\n", | ||
| "| **VectorStore Method** | **Input Dataclass** | **Output Dataclass** |\n", | ||
| "\n", |
Collaborator
There was a problem hiding this comment.
This doesn't render right for me
|
|
||
| def get_router(vector_stores: list[VectorStore], endpoint_names: list[str]) -> APIRouter: | ||
| """Create and return a FastAPI router with search endpoints. | ||
| """Create and return a FastAPI.APIRouter with search endpoints. |
Collaborator
There was a problem hiding this comment.
Suggested change
| """Create and return a FastAPI.APIRouter with search endpoints. | |
| """Create and return a `FastAPI.APIRouter` with search endpoints. |
| endpoint_names (list[str]): A list of endpoint names corresponding to the vector stores. | ||
| vector_stores (list[VectorStore]): A list of `VectorStore` objects, each responsible for handling embedding and search operations for a specific endpoint. | ||
| endpoint_names (list[str]): A list of endpoint names corresponding to the `VectorStore`s to be exposed. | ||
| port (int): [optional] The port on which the API server will run. Defaults to 8000. |
Collaborator
There was a problem hiding this comment.
Suggested change
| port (int): [optional] The port on which the API server will run. Defaults to 8000. | |
| port (int): [optional] The port on which the API server will run. Defaults to 8000. | |
| Raises: | |
| DataValidationError: Raised if the input port is out of bounds. |
| data_type (str): The type of input data (currently supports only "csv"). | ||
| vectoriser (object): The vectoriser object used to transform text into | ||
| vector embeddings. | ||
| vectoriser (object): The `Vectoriser` object used to transform text into |
Collaborator
There was a problem hiding this comment.
Suggested change
| vectoriser (object): The `Vectoriser` object used to transform text into | |
| vectoriser (VectoriserBase): The `Vectoriser` object used to transform text into |
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
2 participants
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.
📌 Tidy up & address Quarto-rendered formatting for first Pages deployment
✨ Summary
Address outdated / missing documentation information and (quarto-rendered) formatting ahead of first Pages deployment.
Scope determined in Excel spreadsheet.
📜 Changes Introduced
✅ Checklist
terraform fmt&terraform validate)🔍 How to Test
Ensure the quarto application is installed locally, then run the following from the repo root directory;
uv run quartodoc builduv run quarto renderuv run quarto previewGo section by section, checking the issues noted in the spreadsheet are resolved to satisfaction.