#swiftdocc — Public Fediverse posts

Finally succeeded in generating HTML documentation for a Swift Package containing several targets, with cross references.
Feature still experimental, customisation is still a chore, but it just works.
Thanks to the community :blobcatheart:

#Swift #SwiftUI #SwiftDocC #SwiftPackage #GitHub
#iOS #iosdev #DesignSystem #opensource

https://ios.unified-design-system.orange.com/documentation/

this works for any documentation you generate with Swift-DocC! you would use the forward-slash key (/) instead for your own docs, but the feature is the same!

#swiftlang #SwiftDocC https://mastodon.social/@schwa/114106083641317923

if you have an existing link to one of our GitHub Pages docs renderings, that won't automatically redirect like the repo will, so you'll need to change `apple.github.io` to `swiftlang.github.io` in your URL.

we have some links in the Swift-DocC repo that need to be updated as soon as our CI is back online 😅 #SwiftDocC #Swift

#SwiftDocC and its sister repos have all been moved to github.com/swiftlang! https://github.com/swiftlang/swift-docc #Swift

is it ready to ship? no. for one, i still need to write tests, but also the frontend stuff i changed is probably a pile of terrible hacks because i'm not actually a frontend dev lol #SwiftDocC #Swift

okay so i'm legit proud of this work

so i've been working on combining overloaded methods into a single “overload group" in curation and navigation. the work is currently landed on main and release/6.0, but right now it will just list all the overloaded symbol declarations on the page without showing you what's actually distinct between them

until now https://github.com/apple/swift-docc/pull/928

#SwiftDocC #Swift

I recently moved the #Adwaita for #Swift docs to #SwiftDocC. So much thanks to the developers of #DocC, it makes maintaining docs extremely easy!

https://aparokshaui.github.io/adwaita-swift/documentation/adwaita/

There's also a beginner tutorial available that walks you through the creation of a #GNOME to-do manager app. It still needs some polishing though. I highly appreciate any form of feedback!

https://aparokshaui.github.io/adwaita-swift/tutorials/table-of-contents

#gtk #libadwaita #swiftui #swiftlang

periodic reminder that Swift-DocC is not necessarily just for documenting Swift and Objective-C code - it doesn't even directly hook into either compiler at all! Marcus ultimately converted the Swift-DocC-Render component hierarchy into a "symbol graph", which Swift-DocC itself uses as the input data for API documentation

theoretically anything that could be represented like this could be used as a data source for DocC documentation, though i will admit that there are some assumptions about the way symbols work in DocC itself today

regardless, this is rad as heck

#Swift #SwiftDocC

here's a cool little project: one of the maintainers of Swift-DocC-Render, the Vue.js frontend for documentation generated with Swift-DocC, wrote up a way to use tree-sitter to generate DocC documentation for DocC-Render! https://github.com/apple/swift-docc-render/pull/746

#Swift #SwiftDocC

And another one! https://github.com/apple/swift-format/pull/615

The rules available in #swift-format are documented now (markdown on GitHub for now, I’ll move them into a #swiftdocc bundle later this weekend): https://github.com/apple/swift-format/blob/main/Documentation/RuleDocumentation.md

And the neat part is that the documentation is automatically generated from the rules source code!

Another nice improvement to #SwiftDocC documentation links (also mentioned in documentation and release notes); a handful of common cases of symbol link disambiguation can be omitted, for example when symbols have different text casing or when later path components are unique to one symbol.

When we adopted this in our symbol documentation for the open source Swift-DocC project it allowed us to use shorter and more readable symbol links in our in-source documentation comments.

Did anyone notice the new #SwiftDocC diagnostics for documentation links yet? 🤓

(mentioned in the Xcode 15 Release Notes and DocC documentation) #WWDC23

#WWDC23! The session "Create rich documentation with Swift-DocC" with @kusters is now live! In it, we'll walk you through how to make the most of your documentation, using new features in Xcode 15 like the new Documentation Preview editor, as well as new authoring capabilities like grid-based layouts and custom themes. Take your documentation to the next level! #SwiftDocC #Swift

https://developer.apple.com/wwdc23/10244

okay, i love (1) the #SwiftDocC shoutout, and also (2) the hilarious way they edited @kusters into the video https://youtu.be/j1HGOY32s2Y?t=33 (0:33 if the timestamp doesn't work)

Announcer: Swift-DocC documentation, anyone?

Ethan: ...yeah. 😅

#WWDC23

Xcode 15 release notes are live, so let's talk about what's new in #SwiftDocC in Xcode!

- you can now preview documentation live as you write it, using an assistant editor! now you can see what your docs look like before you even build them

- documentation built with Xcode 15 now includes Swift extensions for external modules by default, meaning your extensions of (e.g.) standard library types now appear in your docs

- a couple basic Doxygen commands (\param and \returns) are now supported, so you can transition to Swift-DocC more easily from something like HeaderDoc

- you can now use doc: links in Markdown link targets, letting you customize the link text to be something other than the page's title

let us know what you think! we've got a session coming out tomorrow showing off what's new, and a lab on Wednesday morning so you can have a chat #WWDC23

Release notes: https://developer.apple.com/documentation/xcode-release-notes/xcode-15-release-notes#Documentation

hello! we've just tagged a version 0.2.0 for Swift-Markdown, based on the Swift 5.8 release. https://github.com/apple/swift-markdown/releases/tag/0.2.0

this means that you can start using Swift-Markdown as a dependency from other packages, and still tag version releases!

#swift #SwiftDocC

redoing my introduction since it's been a minute and i've increased the post length limit since then, lol

hi! 👋 i'm a quiet misdreavus. if you work with me or we're friends, you can call me victoria.

(if you don't know what a misdreavus is, it's a kind of pokémon! https://bulbapedia.bulbagarden.net/wiki/Misdreavus_(Pokémon) )

in a past life i put a lot of time and energy into maintaining rustdoc and docs.rs for Rust. i don't write any rust nowadays, but i still have a lot of friends in the Rust world. #rustlang

right now i work at That One Computer Company helping maintain Swift-DocC, a documentation tool for Swift. i do a lot of stuff in the Swift compiler and with Markdown for that. #swift #SwiftDocC

i'm trans, autistic, and plural (with a DID diagnosis), and those things color my experience of the world. #ActuallyAutistic #PluralGang

#introduction #introductions

am i still unreasonably proud of the markdown stuff i did last summer? heck yeah i am. anyway here are a couple new things in Xcode 14.3

#swift #SwiftDocC #Xcode #markdown

fucking around has proven fruitful, time for the finding out https://github.com/apple/swift-docc/pull/497

#swift #SwiftDocC

in which i decided to fuck around, in the hopes of finding out https://github.com/apple/swift-markdown/pull/107

#SwiftDocC #Swift

i have successfully nerd-sniped myself into adding HTML output to swift-markdown, because i thought it was missing and also because i thought it could be cool https://github.com/apple/swift-markdown/pull/106

#swift #SwiftDocC #markdown

oh right lol, i guess i should tag work things with #SwiftDocC

go check out this PR, i'm actually kinda proud of it