[Feature Request]: Make documents available on GitHub Pages

[KC-2001MS]

[Feature Request]: Make documents available on GitHub Pages

[MasterJ93]

Thanks for your suggestion. This is a feature I'm planning on doing later down the line, but I didn't think it would be something that anyone would be interested at this current time, so I put it at a medium priority. Given what you've said, I'll make an effort to work on the DocC more so it's more organized and put it up on GitHub Pages. I hope to complete that some time within the next two weeks.

[MasterJ93]

I'll be closing this issue now. But if there's any issues, please re-open it.

Over time, the documentation will be updated with articles, re-structuring into a more organized layout, and tutorials. But this project is still pretty unstable, so I apologize in advance if things break.

I hope my project has enough value and features to create the projects you're trying to build. ☺️

[KC-2001MS]

The sample project is created in the develop branch.
Shall I make a pull request?

[MasterJ93]

Yes, I am okay with you making that pull request for this feature.

[KC-2001MS]

We have made a pull request about Docc. If there is a problem, I will address it.
I don't do pull requests very often, so sorry if it doesn't look well done.

[MasterJ93]

Hmm... it doesn't seem to be working properly. I'm going to re-open this issue until I solve it, but all it's showing is a white image. This is a little bit frustrating.

Please note that this isn't your fault: I may have messed something up here.

[KC-2001MS]

The URL generated by swift-docc-plugin is complicated, so maybe I have the wrong URL. The following URL should be correct.
https://masterj93.github.io/ATProtoKit/documentation/atprotokit/

[MasterJ93]

Yes, when I removed the custom domain, it worked. What I'm attempting to do is getting the following link to work: https://atprotokit.cjrriley.com/ATProtoKit/documentation/atprotokit/. It appears GitHub is having some trouble with this. I'll be able to figure it out, though.

[MasterJ93]

I'll be pointing it to https://cjrriley.com/ATProtoKit/documentation/atprotokit instead. I've noticed that you've done something similar on your end, and so I'll do the same. It's currently grabbing the SSL certificates.

[KC-2001MS]

The reason for that URL is that I am using a custom domain in the KC-2001MS.github.io repository, which is changing the URL of the documentation page in the ATProtokit repository.
Therefore, the ATProtokit repository itself is not adapting the custom domain.

[KC-2001MS]

I'm not sure why, but when I set a custom domain in Github Pages in the <User Name>.github.io repository, that domain is propagated in Github Pages in other repositories.

[MasterJ93]

I'll rebuild the DocC and see if it fixes anything. If not, I have a few more ideas.

[KC-2001MS]

We can see it at the following URL. Thanks for the documentation release.
https://cjrriley.com/documentation/atprotokit/

[MasterJ93]

Oh! I wasn't expecting that to happen. Okay. This is good. I'm not too sure how that happened, though. I guess in this case, typing ATProtoKit wasn't needed after all.