Skip to content

📖 [Docs]: README pages now use the standard module landing-page format - #12

Closed
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
docs/fix-readme-placeholders
Closed

📖 [Docs]: README pages now use the standard module landing-page format#12
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
docs/fix-readme-placeholders

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

The Domeneshop README now follows the standard PSModule landing-page format.

Because this module is still a scaffold-only placeholder, the README keeps its minimal placeholder shape (title, one-line description, ## Status, ## Documentation) and does not show any usage examples for commands that do not exist yet. The ## Contributing section has been removed so contribution guidance lives in the shared community/process files rather than being duplicated per repository.

What changed

  • Removed the ## Contributing section from README.md.
  • Kept the placeholder shape and status notice intact (no invented commands or usage examples).

Scope

  • README.md only.

Copilot AI review requested due to automatic review settings July 5, 2026 23:33
Copilot AI reviewed Jul 5, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository README to remove the generated template placeholders and replace them with a minimal, repository-specific description plus an explicit “placeholder” status statement.

Changes:

  • Replaced templated {{ NAME }} / {{ DESCRIPTION }} content with a concrete project name and short description.
  • Removed template boilerplate sections (prerequisites, installation, usage, documentation, acknowledgements).
  • Added an explicit “Status” note indicating the repository/module is still scaffolded and not yet ready for documented usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: fix README placeholders Docs: standardize README Jul 6, 2026
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copilot AI reviewed Jul 6, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: standardize README 📖 [Docs]: README pages now use the standard module landing-page format Jul 6, 2026
Copilot AI review requested due to automatic review settings July 12, 2026 10:33
@MariusStorhaug Marius Storhaug (MariusStorhaug) added the documentation Improvements or additions to documentation label Jul 12, 2026
Copilot AI reviewed Jul 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread README.md Outdated
Copilot AI reviewed Jul 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@github-actions

github-actions Bot commented Jul 12, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copilot AI review requested due to automatic review settings July 12, 2026 10:37
Copilot AI reviewed Jul 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@github-actions

github-actions Bot commented Jul 12, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs/fix-readme-placeholders branch July 25, 2026 19:32
Merged
Marius Storhaug (MariusStorhaug) added a commit that referenced this pull request Jul 25, 2026
@MariusStorhaug
Merge PR #12 README landing page improvements
311f50a
Marius Storhaug (MariusStorhaug) added a commit that referenced this pull request Jul 26, 2026
@MariusStorhaug @dependabot
🌟[Major]: Domeneshop API capabilities now available (#16)
4609ec2 
Domeneshop users gain authenticated access to the module's domain, DNS,
forwarding, DDNS, and invoice capabilities through a consolidated
pre-1.0 release candidate.

## New: Domeneshop API capabilities

The module adds Context-based credential handling and commands for
querying domains, managing DNS records and forwards, updating DDNS, and
retrieving invoices. Command safety, validation, focused tests, and
command-group documentation are included in the release candidate.

## New: Guided credential setup

Running `Connect-DomeneshopAccount` without `-Secret` or its `-Key`
alias opens the Domeneshop API settings page and securely prompts for
the secret. If a browser is unavailable, the command warns and continues
to the secure prompt. Explicit string and SecureString inputs remain
supported, and `-WhatIf` does not open the browser, prompt, or change
stored contexts.

## Changed: Release tooling and documentation

The release candidate adopts Process-PSModule v6.1.13, enforces Pester
6.x across every test file, consolidates public command tests into
root-level group suites, migrates the generated documentation site to
Zensical, replaces README placeholders with the standard module landing
page, and links each public command's help to its canonical generated
documentation.

---

<details>
<summary>Technical details</summary>

- Integrated PR #11, PR #13, the preserved pull ref for PR #12, PR #14,
and stacked PR #15 in the requested order; each exact source head is
verified as an ancestor of this branch. All five source PRs are now
closed and their remote branches deleted.
- Resolved the PR #11/PR #13 workflow overlap in favor of PR #13's
Process-PSModule v6.1.4 baseline, then updated the consolidated release
to latest Process-PSModule v6.1.13 at immutable commit
`fb1bdb8fefd243292f779d2a856a38db6fe6daf4`.
- Migrated `.github/mkdocs.yml` to `.github/zensical.toml`, satisfying
v6.1.13's Zensical-only documentation pipeline.
- PR #14 was merged explicitly before PR #15; PR #15's existing ancestry
was retained, so only its four standards-hardening commits were
introduced by the later merge.
- Added an integration commit applying PR #13's exact Pester 6.x
requirement to the command tests introduced by PR #15.
- Uses the Standard test-layout profile: grouped public commands are
covered by root-level `tests/<Group>.Tests.ps1` suites (`Auth`, `Ddns`,
`Dns`, `Domains`, `Forwards`, and `Invoices`), while ungrouped and
cross-cutting suites remain separate at the root. Deterministic layout
coverage verifies every public command has a matching `Describe` block
in its expected suite.
- Added interactive credential setup as a separate micro-commit,
including the exact `https://domene.shop/admin?view=api` launch,
`Read-Host -AsSecureString`, `Key` alias, side-effect-free `-WhatIf`
behavior, and a warning-only browser fallback that preserves secure
prompting.
- Added group-aware canonical links first in all 14 public function help
blocks: `https://psmodule.io/Domeneshop/Functions/<FunctionName>/` for
ungrouped commands and
`https://psmodule.io/Domeneshop/Functions/<Group>/<FunctionName>/` for
grouped commands. Deterministic tests require the exact trailing-slash
route and reject missing, incorrect, or secondary-first links.
- Linked clearly owned private Auth helpers to the published public
commands they support while retaining useful secondary Context links.
- Requires PowerShell 7.6, the latest LTS. The generated module manifest
declares `PowerShellVersion = 7.6` and `CompatiblePSEditions = Core`;
legacy Windows PowerShell compatibility branches are intentionally
excluded.
- Rejects whitespace-only API tokens, DDNS values, DNS filters, domain
filters, forward hosts, and smoke-test names before state changes or URI
construction.
- Addressed generated-document lint, reserved context names, empty
secrets, missing context diagnostics, strict WhatIf mutation boundaries,
portable test paths, output contracts, and automated-review findings
discovered during integration.
- Local validation: 83 Pester tests pass, PSScriptAnalyzer reports zero
findings across `src` and `tests`, and `git diff --check` passes.
- Exact-head Process-PSModule v6.1.13 CI succeeds on `9834688` (run
`30180761797`), including Build-Site and all module-local suites across
Linux, macOS, and Windows.
- PSModule/docs PR #86 and Process-PSModule PR #419 are merged, making
latest-LTS support and ternary allowance effective on their default
branches.

</details>

<details>
<summary>Relevant issues (or links)</summary>

- Fixes #2
- #11
- #12
- #13
- #14
- #15
- PSModule/docs#86
- PSModule/Process-PSModule#419

</details>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MariusStorhaug