PdfSharpCore icon indicating copy to clipboard operation
PdfSharpCore copied to clipboard

documentation

Open pamapa opened this issue 3 years ago • 3 comments

What this project lacks most is proper documentation. Currently we have to search through http://www.pdfsharp.net/. What happens if that site is gone. What if this project adds new features or changes the API.

We could help porting the documentation from http://www.pdfsharp.net/ here. I propose to add markdown files with the following directory structure:

  • docs/index.md
  • docs/PDFsharpCore/index.md
  • docs/PDFsharpCore/feature-name1.md
  • docs/MigraDocCore/index.md
  • docs/MigraDocCore/feature-name1.md

Alternative:

  • docs/index.md
  • PDFsharpCore/docs/index.md
  • PDFsharpCore/docs/feature-name1.md
  • MigraDocCore.Rendering/docs/index.md
  • MigraDocCore.Rendering/docs/feature-name1.md

pamapa avatar Jun 02 '22 08:06 pamapa

Would you accept such a MR (alternative structure or not)?

pamapa avatar Jun 02 '22 12:06 pamapa

Sure, sounds reasonable.

ststeiger avatar Jun 03 '22 08:06 ststeiger

I'd go with your first suggestion for the docs structure. I'll try to convert some pages to help with the docs.

MichelMichels avatar Jun 08 '22 11:06 MichelMichels