Skip to content

Commit

Permalink
add instructions to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
goodroot authored Jul 4, 2024
1 parent 936efbf commit 0ec29cd
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
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.

0 comments on commit 0ec29cd

Please sign in to comment.