Upgraded the documentation to use the latest docfx tool #1143
Conversation
Docs/docfx.json
Outdated
| "_enableSearch": true, | ||
| "pdf": false, | ||
| "pdfTocPage": false, | ||
| "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1\"><p> © 2013 - 2024 SVG-NET</p><p>Made with <a href=\"https://dotnet.github.io/docfx\">DocFX</a></p></div>", |
There was a problem hiding this comment.
Not sure about that copyright. It has been Microsoft, then vvvv, then svg-net - maybe these should be noted separately for the respective years.
There was a problem hiding this comment.
Not really sure it was a Microsoft software as those days a project created by Visual Studio included Properties/AssemblyInfo.cs with the copyright portion marked as (c) Microsoft.
There was a problem hiding this comment.
Yes, and that AssemblyInfo.cs is still there, which has AssemblyCopyright("Copyright © Microsoft 2006").
There was a problem hiding this comment.
So, if we want to have a copyright here, it should be (c) 2006 Microsoft, and maybe also 2011 vvvv group, though I would ask @tebjan about this one.
There was a problem hiding this comment.
See the Nuget Package: Copyright © vvvv.org. I thought you said it was transferred to SVG-NET.
There was a problem hiding this comment.
The repository was transferred, but that does not mean that the copyright will disppear, as far as I understand (mind you, I'm not a lawyer, and I understand very little about this stuff).
What I have seen in similar situations is something like this:
© Copyright 2009 Microsoft. All Rights Reserved. © Copyright 2011 vvvv Group. All Rights Reserved. © Copyright 2021 SVG.NET Contributors
This is admittedly a mouthful, not sure if we really need this. Still would like @tebjan to comment on this.
There was a problem hiding this comment.
© Copyright 2009 Microsoft. All Rights Reserved. © Copyright 2011 vvvv Group. All Rights Reserved. © Copyright 2021 SVG.NET Contributors
This looks good! I would go with that. Thanks for considering.
Docs/articles/Introduction.md
Outdated
|
|
||
| ## Downloads | ||
| The SVG-NET is available as [NuGet Package](https://www.nuget.org/packages/svg). | ||
| The respository includes |
There was a problem hiding this comment.
respository -> repository ??
Docs/articles/ReleaseNotes.md
Outdated
| * Added: Support for .NET 4.7.2, .NET 4.8.1 and .NET 8.0. | ||
| * Added: A new project, `Tests/Svg.Tests.Common` for sharing codes between test applications. | ||
| * [Breaking change] The support for .NET 8 resulted in a breaking change to the signature of methods in `CoordinateParser`. | ||
| * [Breaking Change] The support for .NET 8 resulted in a breaking change to the signature of methods in `CoordinateParser`. | ||
| * The changes are needed to fix a compiler error `CS8352`. | ||
| * The use of read-only arguments as referenced variable is not necessary. | ||
| * The use of `ref` in the function arguements resulting in `CS8352` error are all removed. |
|
Off-topic: this PR is actually not relevant for a patch release, and may still take a while to get finally consolidated. Would it be ok if I made a patch release without it (see #1147)? |
|
Re: typos - we probably need a type checker hook to make this easier - I use this in my Python repos... It is easy to overlook typos. As for the patch release - I'll probably just do it - releases are cheap! |
- Updated the builddocs.yml - Renamed the doc to Docs - Moved the doc/*.md files to Doc/articles/*.md - Moved the docfx.json to Doc/docfx.json - Moved the index.md to Doc/index.md
- Updated actions versions
- clarified the organization transfer - removed using company except in the global README
- Added Infrastructure section - Updated namespace descriptions
- as proposed by @tebjan
Docs/docfx.json
Outdated
| "_enableSearch": true, | ||
| "pdf": false, | ||
| "pdfTocPage": false, | ||
| "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1\"><p> © 2013 - 2024 SVG-NET</p><p>Made with <a href=\"https://dotnet.github.io/docfx\">DocFX</a></p></div>", |
There was a problem hiding this comment.
© Copyright 2009 Microsoft. All Rights Reserved. © Copyright 2011 vvvv Group. All Rights Reserved. © Copyright 2021 SVG.NET Contributors
This looks good! I would go with that. Thanks for considering.
|
I'm going to merge this now, as all problems seem to be resolved (I updated the copyright in the last commit). |
Note
For the documentation review, I have deployed the output to GitHub-Pages on my fork.
URL: https://paulushub.github.io/SVG/
Nerdbank.GitVersioning is currently generating error in docs build, probably because it is building on my fork!
Description
builddocs.ymlto the newdocfxworkflow format.doctoDocsdoc/*.mdfiles toDocs/articles/*.mddocfx.jsontoDocs/docfx.json(updated to support latestdocfxversion)index.mdtoDocs/index.mdType of change
Docs/Readme.mdfile, to be included as Readme file in NuGet Package.How Has This Been Tested?