-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |