From 0ec29cd26bde4578b9bb8e8d83aa6b36d25009bf Mon Sep 17 00:00:00 2001 From: goodroot <9484709+goodroot@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:05:32 -0700 Subject: [PATCH 1/2] add instructions to the README --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 87873549..70787ea9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# documentation -The soon to be future location of QuestDB's raw doc files. +# QuestDB documentation + +Documentation files consumed by the [QuestDB website](https://questdb.io). + +## Contributing + +We are always happy to have contributions to the project whether it is +documentation, bug reports, blog posts, or feedback. + +To start, have a look through the [GitHub issues](https://github.com/questdb/documentation/issues) + +## How to contribute + +PR previews are available to see your changes fully built. + +Using markdown preview functionality in your editor should be sufficient for most content. + +If you need help with components or something not offered by the raw markdown, please let us know. + +## Bugs and features + +Raise a [GH issue](https://github.com/questdb/documentation/issues/new/choose) for +bug report, update request, or tutorial proposal using the respective template. + +## Linting + +No need to lint manually. + +Webpack will take care of that for you! + +## Legal Notice + +When contributing to this project, you must agree that you have authored 100% of +the content, that you have the necessary rights to the content and that the +content you contribute may be provided under the project license. From 729342619c4e5459e0c73fed7ffec190578973fa Mon Sep 17 00:00:00 2001 From: goodroot <9484709+goodroot@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:06:24 -0700 Subject: [PATCH 2/2] add community link to README --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 70787ea9..3ba143cd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Documentation files consumed by the [QuestDB website](https://questdb.io). ## Contributing We are always happy to have contributions to the project whether it is -documentation, bug reports, blog posts, or feedback. +documentation, bug reports, or feedback. To start, have a look through the [GitHub issues](https://github.com/questdb/documentation/issues) @@ -28,6 +28,10 @@ No need to lint manually. Webpack will take care of that for you! +## Community + +Want to chat with the team? [Visit the community forum](https://community.questdb.io)! + ## Legal Notice When contributing to this project, you must agree that you have authored 100% of