Skip to content

Documentations in docs folder to be updated #1803

@XuechunHHH

Description

@XuechunHHH

Overview

This issue tracks documentation files that need to be updated in our repository.

Documents Requiring Updates

Document Description Document Path Last Modification Notes
Tutorial example query files https://github.com/partiql/partiql-lang-kotlin/tree/main/docs/wiki/assets/code v0.3.0
Code style description https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/design/CODE-STYLE.md v0.2.3
Aggregate function documentation https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/documentation/Aggregate%20Functions.md v0.9.3
Function documentation https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/documentation/Functions.md v0.14.6 May have missings before last modified version
Related Reading https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/documentation/Further%20Reading.md v0.8.0 Broken Link
Impl vs Spec https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/documentation/Implementation%20%26%20Specification%20Comparison.md v0.7.0
Unit tests & Code coverage https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/documentation/PartiQL%20Code%20Coverage.md v0.13.0
Window Function https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/documentation/Window%20Functions.md v0.8.2
homepage https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/general/Home.md v0.8.0
CLI tutorial https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/tutorials/Command%20Line%20Tutorial.md v0.9.2 Largely outdated
Tutorial https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/tutorials/Tutorial.md v0.9.1 Largely outdated
CLI upgrade log https://github.com/partiql/partiql-lang-kotlin/blob/main/docs/wiki/upgrades/cli-versions.md v0.8.2

Update Checklist

For each document:

  • Review current content
  • Identify specific sections needing updates
  • Make necessary updates
  • Tag according PLK version

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions