From beb05362bf9096a21bdc616c3b20280d2b392672 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20Maih=C3=B6fer?= Date: Thu, 25 Jul 2024 09:46:34 +0200 Subject: [PATCH] docs --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 540dc04..886c93b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ -# report problem with cables +# docs + +This repository contains files of the documentation on the cables.gl website: +- https://cables.gl/docs/docs + +## Giving Feedback + +# Issues and discussions + +Discuss cables.gl features, ask questions, report problems, show patches etc: +- https://github.com/cables-gl/cables_docs/discussions + +Request feature or report bugs: +- https://github.com/cables-gl/cables_docs/discussions/new + +### Issue Workflow + +- create an issue, pick "Bug report" or "Feature Request" from the templates +- the issue will be assigned a "new" label +- we will check on these issues regularly, add them to a milestone and remove the "new" label +- once we added the feature or fixed the bug in any release (also dev/nightly) we will close the issue +- stable releases will have a changelog with all the closed issues + -Discuss cables.gl features, problems, patches etc: -https://github.com/cables-gl/cables_docs/discussions -report bugs or ask questions: -https://github.com/cables-gl/cables_docs/discussions/new -# docs -This repository contains files of the documentation on the cables.gl website: -https://cables.gl/docs/docs