Skip to content

docs: add toolchain#401

Merged
adespawn merged 7 commits intoscylladb:mainfrom
dgarcia360:docs-add-toolchain
Mar 9, 2026
Merged

docs: add toolchain#401
adespawn merged 7 commits intoscylladb:mainfrom
dgarcia360:docs-add-toolchain

Conversation

@dgarcia360
Copy link
Copy Markdown
Contributor

@dgarcia360 dgarcia360 commented Feb 24, 2026

Closes #303

Motivation

Adds a sample docs site to the project & autogenerates docs from jsdoc.

How to test

  1. Make sure you meet the prerequisites.
  2. Clone the PR.
  3. Go to the docs folder: cd docs
  4. Build the docs: make preview
  5. The site should render at http://127.0.0.1:5500/
  6. Open http://127.0.0.1:5500/api to preview the API refernece.

Next steps after merging

  1. Add content to the site (maintainers)
  2. Request zendesk tag for this project, optional (@annastuchlik)
  3. Request subdomain to IT (@annastuchlik, @dgarcia360 )
  4. Configure GitHub Pages (maintainers)

Could you please enable the following option?

In the repository’s Settings, navigate to the Pages section and select GitHub Actions as the deployment source.

image

Thanks!

@dgarcia360 dgarcia360 marked this pull request as draft February 24, 2026 10:05
@dgarcia360 dgarcia360 marked this pull request as ready for review February 24, 2026 11:04
Copy link
Copy Markdown
Contributor

@adespawn adespawn left a comment

Choose a reason for hiding this comment

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

I can see the site building correctly, but it seems to contain only API reference - the documentation (./doc/src) is missing

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Will this file need to be manually updated when changing README?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, but it is placeholder content right now. You'll decide what to document in the frontpage with @annastuchlik (#401 (comment))

@annastuchlik
Copy link
Copy Markdown

I can see the site building correctly, but it seems to contain only API reference - the documentation (./doc/src) is missing

This is expected. This PR just adding the automation part, including the API docs.
Let's work on the actual docs in a follow-up PR. We need to decide what to expose to the customer and how to organize the content.

Comment on lines +19 to +22
# Setup commands
.PHONY: setupenv
setupenv:
pip install -q poetry
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔧 Please use uv, just as @Lorak-mmk did in Rust Driver: scylladb/scylla-rust-driver#1528

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It has broader implications since we have this toolchain installed across 15+ docs projects and we have to maintain it. If it makes sense, we'll do it as a follow-up PR and help all projects migrate to uv at once.

We're now upgrading the theme to support Python 3.14 & Sphinx 9. Might be the right time to make the switch (main benefit is uv is 10–100x faster than poetry for dependency resolution and installs). @annastuchlik, thoughts?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Imo main benefit is that uv works, and is not a pain to work with, as compared to any other Python package / project manager.
Some projects already migrated:

@wprzytula wprzytula added the documentation Improvements or additions to documentation label Feb 25, 2026
@adespawn
Copy link
Copy Markdown
Contributor

Could you please enable the following option?

This option was already enabled

@annastuchlik
Copy link
Copy Markdown

Can this PR be merged now?

@adespawn adespawn merged commit 0423da8 into scylladb:main Mar 9, 2026
11 checks passed
This was referenced Mar 23, 2026
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.

Documentation sources

5 participants