Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: add versioning information to the docs #385

Closed
boisei0 opened this issue Oct 30, 2019 · 1 comment · Fixed by #386
Closed

Proposal: add versioning information to the docs #385

boisei0 opened this issue Oct 30, 2019 · 1 comment · Fixed by #386

Comments

@boisei0
Copy link

boisei0 commented Oct 30, 2019

At the moment the documentation for JSONata does not say when functions got added/changed. As a result, when attempting to write syntax on (older) versions, I have to look up on the releases page when this functionality got added, or if it is even released already (see $type for a post 1.7.0 addition that is on the live docs already: http://docs.jsonata.org/object-functions#type)

Another option could be to have separate documentation for each major version, with the information matching the specific version. Still, it would be good to have information on when specific aspects got changed, for example the $reduce function for 1.7.0.

@andrew-coleman
Copy link
Member

I agree this is needed. The simplest solution (for me) is to use the versioning feature of docusaurus to generate separate versions of the documentation for each release (your second option).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants