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
16 changes: 8 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ We encourage and value all types of contributions. Refer to the [Table of Conten
## Table of Contents <!-- omit in toc -->

- [Development Contributions](#development-contributions)
- [Project Conventions](#project-conventions)
- [Development and Build Process](#development-and-build-process)
- [Commands](#commands)
- [Adding Extensions](#adding-extensions)
- [Open Tasks](#open-tasks)
- [Project Conventions](#project-conventions)
- [Development and Build Process](#development-and-build-process)
- [Commands](#commands)
- [Adding Extensions](#adding-extensions)
- [Open Tasks](#open-tasks)
- [Documentation Contributions](#documentation-contributions)
- [Support Contributions](#support-contributions)
- [Answering Questions](#answering-questions)
- [Validating Bug Reports](#validating-bug-reports)
- [Contributing to Enhancement Suggestions](#contributing-to-enhancement-suggestions)
- [Answering Questions](#answering-questions)
- [Validating Bug Reports](#validating-bug-reports)
- [Contributing to Enhancement Suggestions](#contributing-to-enhancement-suggestions)

## Development Contributions

Expand Down
88 changes: 44 additions & 44 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
name: Bug Report
description: If you come across a bug while using the Inkdex website, please use the following template to report it and help us improve it.
labels:
- "needs triage"
- "bug"
- "needs triage"
- "bug"
assignees: []
body:
- type: markdown
id: message
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: preflight-checklist
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I have read and agree to follow the [code of conduct](https://github.com/inkdex/inkdex.github.io?tab=coc-ov-file#readme).
required: true
- label: I have read and agree to follow the [support guidelines](https://github.com/inkdex/inkdex.github.io/blob/master/.github/SUPPORT.md).
required: true
- label: I experienced this bug on the [inkdex.github.io](https://inkdex.github.io) website.
required: true
- label: I have searched the [issue tracker](https://github.com/inkdex/inkdex.github.io/issues?q=is%3Aissue+is%3Aopen+label%3Abug) for a bug report that matches the one I want to file, without success.
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the Bug
description: A clear and concise description of the bug that you encountered and what you expected to actually happen.
placeholder: Tell us about the bug!
validations:
- type: markdown
id: message
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: preflight-checklist
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I have read and agree to follow the [code of conduct](https://github.com/inkdex/inkdex.github.io?tab=coc-ov-file#readme).
required: true
- type: textarea
id: bug-replication
attributes:
label: Steps to Reproduce
description: Tell us how you triggered the bug so we can try to reproduce it ourselves.
placeholder: 1. ...
validations:
- label: I have read and agree to follow the [support guidelines](https://github.com/inkdex/inkdex.github.io/blob/master/.github/SUPPORT.md).
required: true
- type: textarea
id: extra-info
attributes:
label: Anything Else?
description: |
Videos, images, logs, or links? Anything that will give us more context about the bug which you are encountering!
- label: I experienced this bug on the [inkdex.github.io](https://inkdex.github.io) website.
required: true
- label: I have searched the [issue tracker](https://github.com/inkdex/inkdex.github.io/issues?q=is%3Aissue+is%3Aopen+label%3Abug) for a bug report that matches the one I want to file, without success.
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the Bug
description: A clear and concise description of the bug that you encountered and what you expected to actually happen.
placeholder: Tell us about the bug!
validations:
required: true
- type: textarea
id: bug-replication
attributes:
label: Steps to Reproduce
description: Tell us how you triggered the bug so we can try to reproduce it ourselves.
placeholder: 1. ...
validations:
required: true
- type: textarea
id: extra-info
attributes:
label: Anything Else?
description: |
Videos, images, logs, or links? Anything that will give us more context about the bug which you are encountering!

Tip: You can attach videos, images, logs or any other file by clicking this area to highlight it and then dragging files in.
placeholder: Videos, images, logs, links, ...
validations:
required: false
Tip: You can attach videos, images, logs or any other file by clicking this area to highlight it and then dragging files in.
placeholder: Videos, images, logs, links, ...
validations:
required: false
30 changes: 15 additions & 15 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
blank_issues_enabled: false

contact_links:
- name: Code of Conduct
url: https://github.com/inkdex/inkdex.github.io?tab=coc-ov-file#readme
about: Please read the code of conduct before creating any issue or discussion post.
- name: Support Guidelines
url: https://github.com/inkdex/inkdex.github.io/blob/master/.github/SUPPORT.md
about: Please read the support guidelines before creating any issue or discussion post.
- name: Asking Questions
url: https://github.com/inkdex/inkdex.github.io/discussions/categories/q-a
about: Use the Q&A Discussions section if you want to ask questions.
- name: Search the Issue Tracker
url: https://github.com/inkdex/inkdex.github.io/issues?q=is%3Aissue
about: Check to make sure there is not an issue that is related to yours.
- name: Our Discord Server
url: https://discord.gg/inkdex
about: You can contact us through our Discord server as well.
- name: Code of Conduct
url: https://github.com/inkdex/inkdex.github.io?tab=coc-ov-file#readme
about: Please read the code of conduct before creating any issue or discussion post.
- name: Support Guidelines
url: https://github.com/inkdex/inkdex.github.io/blob/master/.github/SUPPORT.md
about: Please read the support guidelines before creating any issue or discussion post.
- name: Asking Questions
url: https://github.com/inkdex/inkdex.github.io/discussions/categories/q-a
about: Use the Q&A Discussions section if you want to ask questions.
- name: Search the Issue Tracker
url: https://github.com/inkdex/inkdex.github.io/issues?q=is%3Aissue
about: Check to make sure there is not an issue that is related to yours.
- name: Our Discord Server
url: https://discord.gg/inkdex
about: You can contact us through our Discord server as well.
88 changes: 44 additions & 44 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
name: Enhancement Suggestion
description: If you have an enhancement suggestion for the Inkdex website, please use the following template to suggest it and help us improve it.
labels:
- "needs triage"
- "enhancement"
- "needs triage"
- "enhancement"
assignees: []
body:
- type: markdown
id: message
attributes:
value: Thanks for taking the time to fill out this enhancement suggestion!
- type: checkboxes
id: preflight-checklist
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I have read and agree to follow the [code of conduct](https://github.com/inkdex/inkdex.github.io?tab=coc-ov-file#readme).
required: true
- label: I have read and agree to follow the [support guidelines](https://github.com/inkdex/inkdex.github.io/blob/master/.github/SUPPORT.md).
required: true
- label: My enhancement suggestion is for the [inkdex.github.io](https://inkdex.github.io) website.
required: true
- label: I have searched the [issue tracker](https://github.com/inkdex/inkdex.github.io/issues?q=label%3Aenhancement) for an enhancement suggestion that matches the one I want to file, without success.
required: true
- type: textarea
id: enhancement-description
attributes:
label: Describe the Enhancement
description: A clear and concise description of the enhancement you would like to see added.
placeholder: Tell us about the enhancement!
validations:
- type: markdown
id: message
attributes:
value: Thanks for taking the time to fill out this enhancement suggestion!
- type: checkboxes
id: preflight-checklist
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I have read and agree to follow the [code of conduct](https://github.com/inkdex/inkdex.github.io?tab=coc-ov-file#readme).
required: true
- type: textarea
id: enhancement-motivation
attributes:
label: Enhancement Motivation
description: Explain how the enhancement will improve an extension in this repository.
placeholder: Tell us the about the benefits it will bring!
validations:
- label: I have read and agree to follow the [support guidelines](https://github.com/inkdex/inkdex.github.io/blob/master/.github/SUPPORT.md).
required: true
- type: textarea
id: extra-info
attributes:
label: Anything Else?
description: |
Images or links? Anything that will give us more context about the enhancement which you are suggesting!
- label: My enhancement suggestion is for the [inkdex.github.io](https://inkdex.github.io) website.
required: true
- label: I have searched the [issue tracker](https://github.com/inkdex/inkdex.github.io/issues?q=label%3Aenhancement) for an enhancement suggestion that matches the one I want to file, without success.
required: true
- type: textarea
id: enhancement-description
attributes:
label: Describe the Enhancement
description: A clear and concise description of the enhancement you would like to see added.
placeholder: Tell us about the enhancement!
validations:
required: true
- type: textarea
id: enhancement-motivation
attributes:
label: Enhancement Motivation
description: Explain how the enhancement will improve an extension in this repository.
placeholder: Tell us the about the benefits it will bring!
validations:
required: true
- type: textarea
id: extra-info
attributes:
label: Anything Else?
description: |
Images or links? Anything that will give us more context about the enhancement which you are suggesting!

Tip: You can attach images or any other file by clicking this area to highlight it and then dragging files in.
placeholder: Images, links, ...
validations:
required: false
Tip: You can attach images or any other file by clicking this area to highlight it and then dragging files in.
placeholder: Images, links, ...
validations:
required: false
14 changes: 7 additions & 7 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Refer to the [Table of Contents](#table-of-contents) to explore the various type

- [I Have a Question](#i-have-a-question)
- [Reporting Bugs](#reporting-bugs)
- [Before Submitting a Bug Report](#before-submitting-a-bug-report)
- [Submitting a Good Bug Report](#submitting-a-good-bug-report)
- [Before Submitting a Bug Report](#before-submitting-a-bug-report)
- [Submitting a Good Bug Report](#submitting-a-good-bug-report)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Before Submitting an Enhancement Suggestion](#before-submitting-an-enhancement-suggestion)
- [Submitting a Good Enhancement Suggestion](#submitting-a-good-enhancement-suggestion)
- [Before Submitting an Enhancement Suggestion](#before-submitting-an-enhancement-suggestion)
- [Submitting a Good Enhancement Suggestion](#submitting-a-good-enhancement-suggestion)

## I Have a Question

Expand All @@ -38,9 +38,9 @@ A good bug report shouldn't leave others needing to chase you up for more inform
2. Make sure to search the internet to see if users outside of the GitHub Community or [Discord server][discord-server] have discussed the issue.
3. To see if other users have experienced (and potentially already solved) the same bug you are having, check if there is not already a bug report existing for your bug in the [issue tracker][issue-tracker-bugs] or [Discord server support channel][discord-server-support-channel]. If there is, add a comment to the existing one instead of opening a new one.
4. Collect the following information about the bug:
- Detailed description of the bug, including what you expected to actually happen.
- Steps to reproduce the bug.
- _(Optional)_ Videos, images, logs, or links.
- Detailed description of the bug, including what you expected to actually happen.
- Steps to reproduce the bug.
- _(Optional)_ Videos, images, logs, or links.

### Submitting a Good Bug Report

Expand Down
40 changes: 20 additions & 20 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
day: monday
groups:
security:
applies-to: security-updates
patterns:
- "*"
minor_patch:
update-types:
- minor
- patch
major:
update-types:
- major
pre_release:
patterns:
- "*"
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
day: monday
groups:
security:
applies-to: security-updates
patterns:
- "*"
minor_patch:
update-types:
- minor
- patch
major:
update-types:
- major
pre_release:
patterns:
- "*"
52 changes: 26 additions & 26 deletions .github/workflows/build-deploy.yaml
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
name: Build and Deploy

on:
push:
branches:
- "master"
push:
branches:
- "master"

permissions:
contents: write
contents: write

concurrency:
group: ${{ github.workflow }}
cancel-in-progress: true
group: ${{ github.workflow }}
cancel-in-progress: true

jobs:
build-deploy:
name: Build Website and Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- name: Checkout Branch
uses: actions/checkout@v4
- name: Setup Node.js Environment
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- name: Install Dependencies
run: npm ci
- name: Bundle Extensions
run: npm run build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: src/.vitepress/dist
build-deploy:
name: Build Website and Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- name: Checkout Branch
uses: actions/checkout@v4
- name: Setup Node.js Environment
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- name: Install Dependencies
run: npm ci
- name: Bundle Extensions
run: npm run build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: src/.vitepress/dist
Loading