From 20ce08133f5dd2f614e268d04422b4b62b6d4cea Mon Sep 17 00:00:00 2001 From: Jason Barden Date: Wed, 13 Aug 2025 23:04:47 +0100 Subject: [PATCH] Move the readmes to the root --- .github/workflows/dotnet.yml | 4 +++- .github/workflows/publish.yml | 2 ++ AStar.Dev.Functional.Extensions.sln | 20 +++++++++++++++++++ .../Readme-option.md => Readme-option.md | 10 ++++------ .../Readme-result.md => Readme-result.md | 0 .../Readme.md => Readme.md | 2 ++ .../blog-post.md => blog-post.md | 0 .../docs => docs}/advanced-usage-option.md | 0 .../docs => docs}/advanced-usage.md | 0 .../docs => docs}/basic-usage.md | 0 .../docs => docs}/core-concepts.md | 0 .../docs => docs}/error-handling-patterns.md | 0 .../docs => docs}/method-reference.md | 0 .../docs => docs}/testing.md | 0 .../AStar.Dev.Functional.Extensions.csproj | 4 ++-- 15 files changed, 33 insertions(+), 9 deletions(-) rename src/AStar.Dev.Functional.Extensions/Readme-option.md => Readme-option.md (96%) rename src/AStar.Dev.Functional.Extensions/Readme-result.md => Readme-result.md (100%) rename src/AStar.Dev.Functional.Extensions/Readme.md => Readme.md (97%) rename src/AStar.Dev.Functional.Extensions/blog-post.md => blog-post.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/advanced-usage-option.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/advanced-usage.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/basic-usage.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/core-concepts.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/error-handling-patterns.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/method-reference.md (100%) rename {src/AStar.Dev.Functional.Extensions/docs => docs}/testing.md (100%) diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml index 1beab2f..86efb60 100644 --- a/.github/workflows/dotnet.yml +++ b/.github/workflows/dotnet.yml @@ -1,4 +1,4 @@ -name: SonarQube +name: Build and analyse with SonarQube on: push: @@ -13,6 +13,8 @@ jobs: build: name: Build and analyze runs-on: windows-latest + permissions: + contents: read steps: - name: Set up JDK 17 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 170a59b..a72640c 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -6,6 +6,8 @@ on: jobs: build: runs-on: ubuntu-latest + permissions: + contents: read env: ProjectName: 'AStar.Dev.Functional.Extensions' diff --git a/AStar.Dev.Functional.Extensions.sln b/AStar.Dev.Functional.Extensions.sln index f7bdda9..1a753cc 100644 --- a/AStar.Dev.Functional.Extensions.sln +++ b/AStar.Dev.Functional.Extensions.sln @@ -16,6 +16,25 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{D1A87C44-FB0 EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{0A5D570A-ACDC-429C-A9EA-9E8D9DA7774C}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{16259E77-6EBB-4B17-94EF-AF149059D5D8}" + ProjectSection(SolutionItems) = preProject + Readme.md = Readme.md + Readme-result.md = Readme-result.md + Readme-option.md = Readme-option.md + blog-post.md = blog-post.md + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{211253BB-7DA6-4078-8105-61B7A58ABB35}" + ProjectSection(SolutionItems) = preProject + docs\advanced-usage-option.md = docs\advanced-usage-option.md + docs\advanced-usage.md = docs\advanced-usage.md + docs\basic-usage.md = docs\basic-usage.md + docs\core-concepts.md = docs\core-concepts.md + docs\error-handling-patterns.md = docs\error-handling-patterns.md + docs\method-reference.md = docs\method-reference.md + docs\testing.md = docs\testing.md + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -35,5 +54,6 @@ Global {2C3EC910-77D3-475C-A9EE-E8F9F9C8C43C} = {267BE110-D583-4557-80D5-0D9E80A05542} {46743FC5-9AAD-46A0-BD96-B2EEA6CE9E23} = {D1A87C44-FB04-49D8-8C34-C6CD33944612} {CD5D55C2-C6D1-4E28-93FD-1A60118403CE} = {0A5D570A-ACDC-429C-A9EA-9E8D9DA7774C} + {211253BB-7DA6-4078-8105-61B7A58ABB35} = {16259E77-6EBB-4B17-94EF-AF149059D5D8} EndGlobalSection EndGlobal diff --git a/src/AStar.Dev.Functional.Extensions/Readme-option.md b/Readme-option.md similarity index 96% rename from src/AStar.Dev.Functional.Extensions/Readme-option.md rename to Readme-option.md index 9ed0db2..6fefc9f 100644 --- a/src/AStar.Dev.Functional.Extensions/Readme-option.md +++ b/Readme-option.md @@ -22,14 +22,10 @@ patterns in C#. ### 🏗️ Structure -encapsulates either: `Option` +`Option` encapsulates either: - ✅ `Some(T)` — a present value -- ❌ — the absence of a value `None` - t - t - t - t +- ❌ `None` — the absence of a value ``` csharp // Create a Some option @@ -229,3 +225,5 @@ public Option ReserveBookWithLogging(string isbn, int quantity) }); } ``` + +Want more? Some additional documentation can be found [here](docs/advanced-usage-option.md) - focusing on async method usage. diff --git a/src/AStar.Dev.Functional.Extensions/Readme-result.md b/Readme-result.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/Readme-result.md rename to Readme-result.md diff --git a/src/AStar.Dev.Functional.Extensions/Readme.md b/Readme.md similarity index 97% rename from src/AStar.Dev.Functional.Extensions/Readme.md rename to Readme.md index d40a3da..413cbe9 100644 --- a/src/AStar.Dev.Functional.Extensions/Readme.md +++ b/Readme.md @@ -12,6 +12,8 @@ Full details can be found [here](Readme-result.md) Full details can be found [here](Readme-option.md) +In addition, there is a [blog post](blog-post.md) that, depending on when you see this, should have been published to this new-fangled t'interweb-thing... + ## Build and analysis ### GitHub build diff --git a/src/AStar.Dev.Functional.Extensions/blog-post.md b/blog-post.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/blog-post.md rename to blog-post.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/advanced-usage-option.md b/docs/advanced-usage-option.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/advanced-usage-option.md rename to docs/advanced-usage-option.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/advanced-usage.md b/docs/advanced-usage.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/advanced-usage.md rename to docs/advanced-usage.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/basic-usage.md b/docs/basic-usage.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/basic-usage.md rename to docs/basic-usage.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/core-concepts.md b/docs/core-concepts.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/core-concepts.md rename to docs/core-concepts.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/error-handling-patterns.md b/docs/error-handling-patterns.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/error-handling-patterns.md rename to docs/error-handling-patterns.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/method-reference.md b/docs/method-reference.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/method-reference.md rename to docs/method-reference.md diff --git a/src/AStar.Dev.Functional.Extensions/docs/testing.md b/docs/testing.md similarity index 100% rename from src/AStar.Dev.Functional.Extensions/docs/testing.md rename to docs/testing.md diff --git a/src/AStar.Dev.Functional.Extensions/AStar.Dev.Functional.Extensions.csproj b/src/AStar.Dev.Functional.Extensions/AStar.Dev.Functional.Extensions.csproj index 77b80bf..38e7793 100644 --- a/src/AStar.Dev.Functional.Extensions/AStar.Dev.Functional.Extensions.csproj +++ b/src/AStar.Dev.Functional.Extensions/AStar.Dev.Functional.Extensions.csproj @@ -9,9 +9,9 @@ true snupkg AStar.Dev.Functional.Extensions - 0.3.0-alpha + 0.3.1-alpha Readme.md - Jason + AStar Development, Jason Barden AStar Development F#-inspired Result type with functional combinators, async support, and LINQ integration. result functional monad async linq