partiql-docs icon indicating copy to clipboard operation
partiql-docs copied to clipboard

Investigate a solution for version based documentation for implementations

Open am357 opened this issue 1 year ago • 0 comments

Adding this issue in partiql-docs to be as a master issue for tracking the work in one place. We can link separate issues for each implementation (E.g., Rust and Kotlin) to this issue.

Currently, we don't have an automated mechanism and infrastructure to create PartiQL documentation with regards to our implementation versions. Ideally we should have a drop-down on hour implementation web-site/wiki that upon selecting a release version, shows the documentation for that specific version; somewhat similar to the following:

  • https://www.postgresql.org/docs/15/index.html
  • https://docs.python.org/3/

DoD

  • We have done a proof-of-concept
  • We have documented available options w/our preferred option
  • We have a plan forward with the required issues created.

am357 avatar Jul 20 '23 23:07 am357