Update bug report issue template to refer to docs site #1347
Conversation
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
thomashoneyman
requested review from
jwiegley,
emilypi and
jmcardon
as code owners
thomashoneyman
commented
Feb 23, 2024
| @@ -9,8 +9,7 @@ assignees: '' | |||
| ## Issue description | |||
|
|
|||
| <!-- | |||
| Before opening a bug, please take a look at the [Pact ReadtheDocs](https://pact-language.readthedocs.io/en/stable/). | |||
| This explains Pact's semantics and some common issues and will also help you to find the information that the issue template asks for. | |||
| Before opening a bug, please take a look at the [Pact documentation](https://docs.kadena.io/pact). This explains Pact's semantics and some common issues and will also help you to find the information that the issue template asks for. | |||
There was a problem hiding this comment.
Alternately, perhaps you want to point to the language reference? Alas, the landing page for the language reference is quite bare.
Suggested change
| Before opening a bug, please take a look at the [Pact documentation](https://docs.kadena.io/pact). This explains Pact's semantics and some common issues and will also help you to find the information that the issue template asks for. | |
| Before opening a bug, please take a look at the [Pact documentation](https://docs.kadena.io/pact/reference). This explains Pact's semantics and some common issues and will also help you to find the information that the issue template asks for. |
There was a problem hiding this comment.
I do favour the first proposal, as it contains also a general introduction.
rsoeldner
approved these changes
Feb 23, 2024
0xd34df00d
approved these changes
Feb 23, 2024
emilypi
approved these changes
Feb 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The issue template still refers to the read the docs website, but visiting that site shows a large, all-caps deprecation notice. This PR adjusts the link in the template to point to docs.kadena.io/pact.