Skip to content

Commit bbfaa35

Browse files
fritz-cZenaMel
andauthored
Docs and PR template tweaks (#1227)
* docs: fix link to docs website * docs: make the link point directly to the docs site * docs: fix broken logo link and make it more resilient to future file shuffling * docs: comment out one thing overlooked in PR request template * docs: use more direct "New Issue" link * docs: fix broken docs directory link * chore: add labels to GitHub issue templates to auto-label certain issues Co-authored-by: Zenahr <[email protected]>
1 parent 00a716a commit bbfaa35

File tree

5 files changed

+8
-6
lines changed

5 files changed

+8
-6
lines changed

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4+
labels: Feature Request
45
---
56

67
<!--

.github/ISSUE_TEMPLATE/question.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: Question
33
about: Ask a question about using Spectacle.
4+
labels: 🤔 Question
45
---
56

67
<!--

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected
66

77
### Description
88

9-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
9+
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
1010

1111
Fixes # (issue)
1212

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img src="https://raw.githubusercontent.com/FormidableLabs/spectacle/main/website/static/img/logo_spectacle.png" width=250></p>
1+
<p align="center"><img src="https://raw.githubusercontent.com/FormidableLabs/spectacle/ac6c9266/website/static/img/logo_spectacle.png" width=250></p>
22
<h2 align="center">Spectacle</h2>
33
<p align="center">
44
<strong>✨ A ReactJS based Presentation Library ✨</strong>
@@ -21,9 +21,9 @@ Come learn more at our [docs site]!
2121
Have a question about Spectacle? Submit an issue in this repository using the
2222
["Question" template](https://github.com/FormidableLabs/spectacle/issues/new?template=question.md).
2323

24-
Notice something inaccurate or confusing? Feel free to [open an issue](https://github.com/FormidableLabs/spectacle/issues) or [make a pull request](https://github.com/FormidableLabs/spectacle/pulls) to help improve the documentation for everyone!
24+
Notice something inaccurate or confusing? Feel free to [open an issue](https://github.com/FormidableLabs/spectacle/issues/new/choose) or [make a pull request](https://github.com/FormidableLabs/spectacle/pulls) to help improve the documentation for everyone!
2525

26-
The source for our docs site lives in this repo in the [`docs`](https://github.com/FormidableLabs/spectacle/blob/main/docs/README.md) folder.
26+
The source for our docs site lives in this repo in the [`docs`](https://github.com/FormidableLabs/spectacle/blob/main/docs) folder.
2727

2828
## Contributing
2929

@@ -33,4 +33,4 @@ Please see our [contributing guide](CONTRIBUTING.md).
3333

3434
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
3535

36-
[docs site]: https://www.formidable.com/open-source/spectacle
36+
[docs site]: https://www.formidable.com/open-source/spectacle/docs/

packages/spectacle/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img src="https://raw.githubusercontent.com/FormidableLabs/spectacle/main/docs/src/assets/logo_spectacle.png" width=250></p>
1+
<p align="center"><img src="https://raw.githubusercontent.com/FormidableLabs/spectacle/ac6c9266/website/static/img/logo_spectacle.png" width=250></p>
22
<h2 align="center">Spectacle</h2>
33
<p align="center">
44
<strong>✨ A ReactJS based Presentation Library ✨</strong>

0 commit comments

Comments
 (0)