Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions .github/ISSUE_TEMPLATE/01-report-a-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:
you want to report, helping us to understand what you are working on and
what you are trying to achieve. If the context is not relevant, you can
leave this field empty.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#context)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#context)

- type: textarea
id: description
Expand All @@ -22,7 +22,7 @@ body:
for MkDocs does not behave as you would expect it to. Be as specific as
possible. If you have found a workaround or a fix for the problem,
please let us maintainers (and all other users) know.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#bug-description)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#bug-description)
validations:
required: true

Expand All @@ -38,9 +38,9 @@ body:
and closed [issues](https://github.com/jaywhj/mkdocs-materialx/issues)
and [discussions](https://github.com/jaywhj/mkdocs-materialx/discussions)
you encountered when searching our issue tracker.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#related-links)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#related-links)
value: |-
- [Reporting a bug](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/)
- [Reporting a bug](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug)
-
validations:
required: true
Expand All @@ -51,11 +51,11 @@ body:
label: Reproduction
description: >-
Please create a __.zip file__ with a __minimal reproduction__ for the
bug. First, read our [reproduction guide](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction/)
that explains the necessary steps, then use the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info/) (mandatory) to create a self-contained
bug. First, read our [reproduction guide](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction)
that explains the necessary steps, then use the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info) (mandatory) to create a self-contained
.zip file with the reproduction. We reserve the right to close issues
without .zip files.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#reproduction)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#reproduction)
placeholder: |-
Drag and drop the .zip file with the minimal reproduction here.
validations:
Expand All @@ -70,7 +70,7 @@ body:
through the required steps, helping us to recreate the problem using the
minimal reproduction you provided. Be as specific as possible and as
verbose as necessary – try not to leave anything out.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#steps-to-reproduce)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#steps-to-reproduce)
placeholder: |-
1. ...
2. ...
Expand All @@ -87,7 +87,7 @@ body:
please select them from the dropdown below. If your browser is not
listed or the version is relevant, you may select _Other_ and provide
more details in the field above.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#browser)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#browser)
multiple: true
options:
- Chrome
Expand All @@ -108,17 +108,17 @@ body:
box. This will save the maintainers and you valuable time.
options:
- label: >-
I have read and followed the [bug reporting guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/).
I have read and followed the [bug reporting guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug).
required: true
- label: >-
I have attached links to [the documentation](https://jaywhj.github.io/mkdocs-materialx/),
and possibly related [issues](https://github.com/jaywhj/mkdocs-materialx/issues)
and [discussions](https://github.com/jaywhj/mkdocs-materialx/discussions).
required: true
- label: >-
I assure that I have [removed all customizations](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#remove-customizations)
I assure that I have [removed all customizations](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#remove-customizations)
before submitting this bug report.
required: true
- label: >-
I have attached a __.zip file__ with a [minimal reproduction](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction/) using the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info/).
I have attached a __.zip file__ with a [minimal reproduction](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction) using the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info).
required: true
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
or indicate where you feel there is a need for improvement. Furthermore,
explain the severity of the issue, i.e., its impact on you and potentially
other users.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#description)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#description)
validations:
required: true

Expand All @@ -29,9 +29,9 @@ body:
and closed [issues](https://github.com/jaywhj/mkdocs-materialx/issues)
and [discussions](https://github.com/jaywhj/mkdocs-materialx/discussions)
you encountered when searching our issue tracker.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#related-links)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#related-links)
value: |-
- [Reporting a docs issue](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/)
- [Reporting a docs issue](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue)
-
validations:
required: true
Expand All @@ -44,7 +44,7 @@ body:
This field is optional. You may provide an improvement proposal for our
documentation by describing your suggestion in the text field below or
creating a pull request after reporting this issue referencing the issue.
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#proposed-change)
[More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#proposed-change)

- type: checkboxes
id: checklist
Expand All @@ -58,8 +58,8 @@ body:
valuable time.
options:
- label: >-
I have read and followed the [documentation issue guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/).
I have read and followed the [documentation issue guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue).
required: true
- label: >-
I have attached the links to the affected sections of [the documentation](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#related-links)
I have attached the links to the affected sections of [the documentation](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#related-links)
required: true
4 changes: 2 additions & 2 deletions docs/archives/blog/posts/goodbye-github-discussions.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ Despite these measures, we faced serveral structural challenges:

[Community Experts Program]: https://github.com/squidfunk/mkdocs-material/discussions/6363
[GitHub Discussions]: https://github.com/features/discussions
[contribution guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing/
[bug reporting guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/
[contribution guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing
[bug reporting guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug

### Addressing these challenges

Expand Down
3 changes: 1 addition & 2 deletions docs/contributing/making-a-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,13 +336,12 @@ shows how your new feature is meant to work.
repository.

[smoke tests]: https://en.wikipedia.org/wiki/Smoke_testing_(software)
[minimal reproduction]: https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction/
[minimal reproduction]: https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction
[MaterialX for MkDocs Examples]: https://github.com/mkdocs-material/examples

- Ideally, also test the examples in the [examples repository].

[examples repository]: https://github.com/mkdocs-material/examples
[projects plugin]: https://jaywhj.github.io/mkdocs-materialx/plugins/projects/

### Creating the pull request

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/blogs/engage.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,5 +365,5 @@ provides comprehensive documentation for the plugin. You may also want to
look at the [social plugin tutorial] to generate social cards for your blog
posts that get displayed when you post links to social media systems.

[blog plugin reference]: https://jaywhj.github.io/mkdocs-materialx/plugins/blog/
[blog plugin reference]: https://jaywhj.github.io/mkdocs-materialx/plugins/blog
[social plugin tutorial]: ../social/basic.md
2 changes: 1 addition & 1 deletion docs/tutorials/blogs/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ them accessible independently of the main navigation structure. Tags are useful
for making related content easily discoverable even if it is in different parts
of the navigation hierarchy.

[Tags plugin]: https://jaywhj.github.io/mkdocs-materialx/plugins/tags/
[Tags plugin]: https://jaywhj.github.io/mkdocs-materialx/plugins/tags

You may have a tutorial like this one as well as a more comprehensive setup guide
and reference documentation. Adding the same tag to all three shows that they
Expand Down