DocC

[oscbyspro]

I suppose having a structured documentation page would be nice.

1. documenting apps, frameworks and packages
2. writing symbol documentation in your source files
3. adding structure to your documentation pages
4. adding supplemental content to a documentation catalog
5. formatting your documentation content
6. distributing documentation to external developers
7. Swift DocC plugin - publishing to GitHub Pages
8. configuring a publishing source for your GitHub Pages site

[oscbyspro]

Paul Hudson: How to document your project with DocC and Xcode13

[oscbyspro]

That awkward moment when you have one lower-case /docs folder.

[oscbyspro]

That awkward moment when /docs contains ~1600 files (14.6 MB). Still, better than .git.

[oscbyspro]

Welp, that didn't work. Hm. Maybe I should use Swift-DocC Plugin, following 's instructions.

[oscbyspro]

"The page you’re looking for can’t be found." is something, but I'm not sure it's much better...

[oscbyspro]

I see, the path is lowercased: documentation/awesomenumberskit ...and it's empty.

[oscbyspro]

I suppose Swift-DocC Plugin does not respect my exporting target.

[oscbyspro]

I mean, it makes sense. I suppose I can build the following instead:

• documentation/ankfoundation
• documentation/ankfullwidthkit
• documentation/anksignedkit

[oscbyspro]

I also think I want a dedicated and unrelated github-pages branch for this.

[oscbyspro]

Hm. I think an unrelated branch is created by git checkout --orphan <name>.

[oscbyspro]

Hm. gh-pages seems special. I suppose I can try that too, maybe it makes a difference.

[oscbyspro]

Wow, would you look at that: gh-pages does not nag me about how out of sync it is!

[oscbyspro]

Also, it appears I can only have one documentation page per repo... Hm, what to do?

[oscbyspro]

Ha! The DocC page is live! 👀

[oscbyspro]

Hm. I think I'll sync the page with every minor release, or something like that.

[oscbyspro]

It takes ~10 minutes for GitHub Pages to show new commits, so some patience is required.