search

hmlongco / Factory

A new approach to Container-Based Dependency Injection for Swift and SwiftUI.
MIT License
1.71k stars 107 forks source link

Removed docs folder in favor of SPI usage #127

Closed o-nnerb closed 1 year ago

o-nnerb commented 1 year ago

This is related with #126. By adding .spi.yml there is no need to host the documentation inside the repository.

Also, Swift Package Index automatically reads the Factory.docc. We can add the swift-version: at the .spi.yml to use the 5.9 so SPI builds the documentation with the latests features released by Apple (but only if is necessary).

hmlongco commented 1 year ago

How does that work with github docs? The files were hosted in the project so they were available as links online in the repo.

o-nnerb commented 1 year ago

It doesn’t work. The Swift Package Index will host for you. Apple did this move to host their open source documentation from GitHub repositories at Swift Package Index.

I’m mean, it’s great because you don’t have to maintain this by yourself.

hmlongco commented 1 year ago

I don't mind supporting documentation on SPI re the other PR, but I also don't want a repository not under my control to be the sole source of documentation for Factory.

Further, there are inbound links to the existing documentation from other sources, including from the README from the project. Declining this one.