Skiasharp: [QUESTION] How the doc of SkiaSharp is written?

Created on 1 Nov 2019  路  2Comments  路  Source: mono/SkiaSharp

I'm curious how the doc of SkiaSharp is written and converted to create the web site https://docs.microsoft.com/en-us/dotnet/api/skiasharp.

I can see a lot of XML at this repo:
https://github.com/mono/SkiaSharp-API-docs

Is the XML hand-written?
Why not put the doc in the source code, then extract it later?

Most helpful comment

I have a WIP for the docs process: https://github.com/mono/SkiaSharp/wiki/Writing-Docs

~Still need to merge https://github.com/mono/SkiaSharp/pull/997~ _(merged)_

It is not perfect yet - I would really like to move all the docs bits into the docs repo, but just not there yet.

All 2 comments

Good question. It is generated from the compiled assemblies and stored in a separate repo for edits and possibly other languages.

I'll put together wiki now.

I have a WIP for the docs process: https://github.com/mono/SkiaSharp/wiki/Writing-Docs

~Still need to merge https://github.com/mono/SkiaSharp/pull/997~ _(merged)_

It is not perfect yet - I would really like to move all the docs bits into the docs repo, but just not there yet.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

joshminor picture joshminor  路  3Comments

corliss picture corliss  路  4Comments

NotOfficer picture NotOfficer  路  3Comments

dsadlowski picture dsadlowski  路  3Comments

joreg picture joreg  路  4Comments