Skip to content

Add initial documentation for the site, outlining features and contri… #1

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.

Sign up for GitHub

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
MariusStorhaug merged 5 commits into from
Oct 13, 2025
Merged

Add initial documentation for the site, outlining features and contri… #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
faaec86
Add initial documentation for the site, outlining features and contri…
MariusStorhaug Oct 13, 2025
f6de5cf
Add version selector JavaScript and update mkdocs configuration
MariusStorhaug Oct 13, 2025
05cac97
Update permissions in GitHub Actions workflow to ensure pull request …
MariusStorhaug Oct 13, 2025
9972d9c
Update deployment command to set documentation preview as hidden for …
MariusStorhaug Oct 13, 2025
b46d24c
Remove version selector JavaScript and default version setting from m…
MariusStorhaug Oct 13, 2025
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
4 changes: 3 additions & 1 deletion .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ on:

permissions:
contents: write
pull-requests: write

jobs:
deploy:
Expand Down Expand Up @@ -39,7 +40,8 @@ jobs:
if ($action -eq 'closed') {
mike delete --push $version
} else {
mike deploy --push $version
mike deploy --push $version --prop-set hidden=true
gh pr comment $prNumber --body "Documentation preview available at https://psmodule.github.io/docs-test/$version/"
}
} else {
mike deploy --push --update-aliases 0.3 latest
Expand Down
13 changes: 13 additions & 0 deletions docs/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# About This Site

This is a test documentation site built with MkDocs and Material theme.

## Features

- Versioned documentation using Mike
- Automated deployment via GitHub Actions
- Pull request previews

## Getting Started

To contribute, create a pull request and see the preview at `pr-{number}`.
1 change: 0 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ extra:
version:
provider: mike
alias: true
default: latest
plugins:
- mike:
alias_type: symlink
Expand Down
Loading