Version online API docs

Open
  • Is something wrong?
#553 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start by investigating how the online API docs at https://ffi.rustls.dev are currently published from the main branch. Define a versioning approach that supports links to a specific version, and confirm that the resulting versioned documentation can be reached reliably.

Written by the indexing model from the issue text.

Description

Presently the docs at https://ffi.rustls.dev are always tracking the main branch. We should consider how we could version these so that it's possible to link to a specific version's docs.

Dominant language
Rust
Stars
171
Forks
45
Avg merge
16h 43m
Merged PRs (30d)
18

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rustls/rustls-ffi

All issues in rustls/rustls-ffi

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.