search

scylladb / cpp-rust-driver

API-compatible rewrite of https://github.com/scylladb/cpp-driver as a wrapper for Rust driver.
GNU Lesser General Public License v2.1
11 stars 11 forks source link

docs: add sample site #134

Open dgarcia360 opened 5 days ago

dgarcia360 commented 5 days ago

Closes #125

Motivation

Adds a sample docs site to the project.

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/

Next steps after merging

  1. Add content to the site (maintainers)
  2. Request zendesk tag for this project, optional (@annastuchlik)
  3. Configure the subdomain (@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!