masterj93/atprotokit

A straightforward solution for using the AT Protocol and Bluesky, written in Swift.

atprotokit's Issues

[Feature Request]: Make documents available on GitHub Pages

Summary

I would like to be able to display documents as static pages so that they can be machine translated.

Pain points

I would like to be able to view the ATProtoKit documentation in a browser so that I can easily check the documentation.
Currently, it is possible to check the documentation by building the documentation in Xcode. However, we believe that displaying documents in a browser is superior because it is platform-independent and machine translation is available.
Therefore, we would like to request the ability to build DocC on GitHub Pages.
The following repositories have already implemented this content.
https://github.com/KC-2001MS/ATProtoKit/tree/develop

Considered Alternatives

Compared to the method of building with Xcode, it is superior in the following points.

• Platform independent. (Available on Windows/Linux)
• Machine translation allows you to check documentation in your native language

Is this a breaking change?

No

Library Examples

We have already created a documentation page for this project in the forked repository.
Please refer to the following URL
https://iroiro.dev/ATProtoKit/documentation/atprotokit
I would like to pull request this devlop branch.

Additional Context

No response

[Feature Request]: Replace print function with Logger

Summary

I want to use Logger to open the line where the log occurred in Xcode.

Pain points

I would like to switch from using the print function to using Logger in order to debug my project more efficiently.
As shown in the following session, the combination of Xcode15 and Logger allows for easier debugging.
https://developer.apple.com/wwdc23/10226
I am also currently adding an Extension to this Logger in the forked repository.
I have not done this because trying to replace all print statements would require changing a few more files. Definitions only.

Considered Alternatives

Compared to the print function used in debugging, this function is superior in that it can easily transition to the part in question.

Is this a breaking change?

No

Library Examples

No response

Additional Context

No response