[Help wanted] Documentation contributions

[macjuul]

Maintaining documentation takes a lot of time and energy, especially for a team as small as ours. As we are often working on many Open Source projects at once, we often find little time left to write and update our docs. For this reason we kindly ask the community and those interested to help expand the Cirql documentation.

What are we looking for?

Cirql is a very dynamic library which can be used in many ways, much like SurrealDB itself. Receiving community input is essential to describe and explain the various use-cases in which Cirql can be used. Naturally we will continue to update our documentation over time and review issues and PRs as frequently as we can. Currently we are seeking to cover the following topics:

• Installation & setup
• Common query examples
• Transactions & batched queries
• Stateless requests
• Explanation on raw() and derivatives
  • How to prevent SQL injections
  • How to prevent table spoofing
• Effective use of zod schemas
  • RecordSchema and EdgeSchema
  • Explanation of .with(), .withAny(), and .withSchema()
• API Reference
  • Documentation for each query writer (code)
  • Available operators (code)
  • Available functions (code)
  • Utilities e.g. parseQueries (code)

How can I help?

You can visit the documentation repository here for further instructions on how you can help. Feel free to open issues on topics you would like to see covered, and submit new pages or improvements as PR's.

Thank you for your time and your interest in Cirql