Skip to content

feat: add screenshots for documentation & docs: ensure GitHub wiki is enabled and initialized #4

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

Merged
merged 2 commits into from
Oct 9, 2024
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
2 changes: 2 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ MD033:
allowed_elements:
- sup
- b
- p
- img

# Code block style
MD046:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,4 @@ jobs:
default-first-tag: v1.0.0
disable-wiki: false
wiki-sidebar-changelog-max: 10
delete-legacy-tags: false # Note: We don't want to delete tags in this repository
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,40 @@ details, and a full changelog.
- **Flexible Configuration**: Offers advanced input options for customization, allowing you to tailor the action to your
specific needs.

## Screenshots

<p float="left" align="center">
<img src="screenshots/wiki-sidebar.jpg"
alt="Wiki Sidebar" style="width: 299px; height: auto; " />
<img src="screenshots/pr-initial-module-release.jpg"
alt="PR Initial Module Release" style="width: 619px; height: auto;" />
<img src="screenshots/pr-separate-modules-updating.jpg"
alt="PR Separate Modules Updating" style="width: 504px; height: auto;" />
<img src="screenshots/wiki-changelog.jpg"
alt="Wiki Changelog" style="width: 500px; height: auto;" />
<img src="screenshots/wiki-usage.jpg"
alt="Wiki Usage" style="width: 500px; height: auto;" />
<img src="screenshots/module-contents-explicit-dir-only.jpg"
alt="Module Contents Explicit Dir Only" style="width: 500px;" />
<img src="screenshots/release-details.jpg"
alt="Release Details" style="width: 500px; height: auto;" />
<img src="screenshots/wiki-module-example.jpg"
alt="Wiki Module Example" style="width: 500px; height:" />
</p>

## Getting Started

### Step 1: Create a Wiki
### Step 1: Ensure GitHub Wiki is Enabled

Before using this action, make sure that the wiki is enabled and initialized for your repository:

Before using this action, you need to create a wiki for your repository. To do this, click the green "Wiki" button on
your repository's homepage and follow the prompts to create a new wiki.
1. Go to your repository's homepage.
1. Navigate to the "Settings" tab.
1. Under the "Features" section, ensure the "Wikis" option is checked to enable the GitHub Wiki.
1. Navigate to the "Wiki" tab on your repository.
1. Click the "Create the first page" button and add a basic title like "Home" to initialize the wiki with an initial
commit.
1. Save the changes to ensure your wiki is not empty when the GitHub Action updates it with module information.

### Step 2: Configure the Action

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/pr-initial-module-release.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/pr-separate-modules-updating.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/release-details.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/wiki-changelog.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/wiki-module-example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/wiki-sidebar.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/wiki-usage.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.