Skip to content

Commit 6fdece6

Browse files
docs: improve formatting and clarity in README sections
1 parent 989df80 commit 6fdece6

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -210,32 +210,32 @@ The [PSModule - Module tests](./scripts/tests/Module/PSModule/PSModule.Tests.ps1
210210
### Get test results
211211

212212
[workflow](./.github/workflows/Get-TestResults.yml)
213-
- Gathers the test results from the previous steps and creates a summary of the results.
214-
- If any tests have failed, the workflow will fail here.
213+
- Gathers the test results from the previous steps and creates a summary of the results.
214+
- If any tests have failed, the workflow will fail here.
215215

216216
### Get code coverage
217217

218218
[workflow](./.github/workflows/Get-CodeCoverage.yml)
219-
- Gathers the code coverage from the previous steps and creates a summary of the results.
220-
- If the code coverage is below the target, the workflow will fail here.
219+
- Gathers the code coverage from the previous steps and creates a summary of the results.
220+
- If the code coverage is below the target, the workflow will fail here.
221221

222222
### Publish module
223223

224224
[workflow](./.github/workflows/Publish-Module.yml)
225-
- Publishes the module to the PowerShell Gallery.
226-
- Creates a release on the GitHub repository.
225+
- Publishes the module to the PowerShell Gallery.
226+
- Creates a release on the GitHub repository.
227227

228228
### Build docs
229229

230230
[workflow](./.github/workflows/Build-Docs.yml)
231-
- Generates documentation and lints the documentation using:
232-
- [super-linter](https://github.com/super-linter/super-linter).
231+
- Generates documentation and lints the documentation using:
232+
- [super-linter](https://github.com/super-linter/super-linter).
233233

234234
### Build site
235235

236236
[workflow](./.github/workflows/Build-Site.yml)
237-
- Generates a static site using:
238-
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
237+
- Generates a static site using:
238+
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
239239

240240
### Publish Docs
241241

@@ -724,7 +724,7 @@ Key expectations:
724724

725725
How the module is built.
726726

727-
```
727+
```plaintext
728728
├── src/ # Module source compiled and documented by the pipeline
729729
│ ├── assemblies/ # Bundled binaries copied into the build artifact
730730
│ ├── classes/ # Class scripts merged into the root module
@@ -791,5 +791,3 @@ The process is compatible with:
791791
- [GitHub Flow specifications](https://docs.github.com/en/get-started/using-github/github-flow)
792792
- [SemVer 2.0.0 specifications](https://semver.org)
793793
- [Continuous Delivery practices](https://en.wikipedia.org/wiki/Continuous_delivery)
794-
795-
[netdt]: https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings

0 commit comments

Comments
 (0)