-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Add support page for issues, requests, and questions #3835
Conversation
@@ -68,6 +68,11 @@ upper_tabs: | |||
- title: "Operators and observables" | |||
path: /cirq/operators_and_observables | |||
|
|||
#### Support #### | |||
- heading: "Support" | |||
- title: "Issues / requests / questions" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you anticipate additional pages? Best to avoid single entry sections, if possible. Can add to the "Contributor guide" below until then
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, there probably won't be additional pages so the single-entry section may be overkill. Then again, it does make this page stick out which I think is good. What do others think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-1 new section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My view is that we should not add this under contributor guide, since the point of adding this is to encourage more feedback from users outside of the contributor community. If we do not want to add a section I would suggest adding this at the bottom of the "further topics" section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved to further topics!
docs/support.md
Outdated
# Questions | ||
|
||
If you're not sure whether a certain behavior is buggy, or if you have other questions, | ||
please ask us in the [Cirq Gitter channel](https://gitter.im/cirqdev). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we link to any email lists, such as cirq-dev? Eventually we should probably link to QCS support email lists, but maybe not yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this idea. I'll add a link to cirq-dev.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
To increase user feedback and make it clear how to report issues on the website.
cc @balopat @lamberta @karlunho
Note: Cirq is the only repo with issue templates.