Merge branch 'main' into kellen/jaro-pr

goodroot · web-flow · commit b00fb8390b5f · 2024-07-04T11:07:37.000-07:00
diff --git a/README.md b/README.md
@@ -1,2 +1,39 @@
-# 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, 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!
+
+## 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
+the content, that you have the necessary rights to the content and that the
+content you contribute may be provided under the project license.
