Skip to content

docs(quarto): Tidy up & address Quarto-rendered formatting for first Pages deployment#148

Merged
lukeroantreeONS merged 20 commits intomainfrom
146-quarto-documentation-review-for-initial-deployment
Mar 11, 2026
Merged

docs(quarto): Tidy up & address Quarto-rendered formatting for first Pages deployment#148
lukeroantreeONS merged 20 commits intomainfrom
146-quarto-documentation-review-for-initial-deployment

Conversation

@lukeroantreeONS
Copy link
Copy Markdown
Contributor

@lukeroantreeONS lukeroantreeONS commented Mar 10, 2026

📌 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

  • docs(hooks): Demo notebook updated - install instructions removed, table reformatted

✅ Checklist

Please confirm you've completed these checks before requesting a review.

  • Code passes linting with Ruff
  • Security checks pass using Bandit
  • API and Unit tests are written and pass using pytest
  • Terraform files (if applicable) follow best practices and have been validated (terraform fmt & terraform validate)
  • DocStrings follow Google-style and are added as per Pylint recommendations
  • Documentation has been updated if needed

🔍 How to Test

Ensure the quarto application is installed locally, then run the following from the repo root directory;

uv run quartodoc build
uv run quarto render
uv run quarto preview

Go section by section, checking the issues noted in the spreadsheet are resolved to satisfaction.

@lukeroantreeONS lukeroantreeONS linked an issue Mar 10, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

@rileyok-ons rileyok-ons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes mainly look much better, got a few updates to the servers and got a formatting issue with the new preprocessing hook table

Comment thread DEMO/custom_preprocessing_and_postprocessing_hooks.ipynb
Comment thread src/classifai/servers/main.py Outdated
Comment thread src/classifai/servers/main.py
Comment thread src/classifai/indexers/main.py
Copy link
Copy Markdown
Contributor

@frayle-ons frayle-ons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things to check

Comment thread src/classifai/indexers/main.py Outdated
Comment thread src/classifai/indexers/main.py Outdated
Comment thread src/classifai/vectorisers/__init__.py Outdated
Comment thread src/classifai/vectorisers/huggingface.py
Comment thread src/classifai/vectorisers/ollama.py
Comment thread src/classifai/servers/main.py
Comment thread src/classifai/vectorisers/__init__.py Outdated
Comment thread src/classifai/indexers/__init__.py
@lukeroantreeONS lukeroantreeONS marked this pull request as ready for review March 11, 2026 16:00
@lukeroantreeONS lukeroantreeONS requested a review from a team as a code owner March 11, 2026 16:00
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 11, 2026
rileyok-ons
rileyok-ons previously approved these changes Mar 11, 2026
Copy link
Copy Markdown
Contributor

@rileyok-ons rileyok-ons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless anyone can see anything else I'm good with this. looks robust

Comment thread src/classifai/indexers/__init__.py Outdated
@lukeroantreeONS lukeroantreeONS merged commit fdeddff into main Mar 11, 2026
5 checks passed
@lukeroantreeONS lukeroantreeONS deleted the 146-quarto-documentation-review-for-initial-deployment branch March 11, 2026 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Quarto Documentation Review for initial deployment

3 participants