[Documentation]: Re-organize DocC
@MasterJ93 is already working on this.
Since Nov 26, 2024.
Assessment
This issue has not been assessed yet.
Description
Summary
The DocC has several inconsistencies and navigational issues
Description
Several pages in the DocC are either outdated, inconsistent, difficult to read and understand, and/or out of place. This issue is simply to mark down all places where things are problematic and fix them accordingly. The result is a cohesive, more developer-friendly experience.
What type of issue is it?
Spelling, Grammar, Inconsistency, Outdated
ATProtoKit Version
0.20.0
Documentation Location
All parts of the DocC
Additional Context
There are many, many sections of the DocC that needs work. Below is a list of what needs to happen.
-
Completed
ATProtoKit,ATProtoBluesky,ATProtoBlueskyChat, andATProtoAdminclasses are currently put in alphabetical order (with respect to purely the methods) and grouped by the type of object. This is okay, but when it comes to classes with a ton of instance methods, it becomes difficult to find what you need.For each class, they need to be organized into different categories, depending on the class. More specifically, methods will need to be organized by task for each class, similarly to how
URLSessioninFoundationhas their methods sorted by different tasks. This gives more opportunities to fit certain relevant articles (and potentially sample code and tutorials) within the sub-sections.For
ATProtoBlueskyin particular, it will be sorted by whatever records are available. They may also be sorted by certain tasks, if need be.ATLinkBuilder-related documentation may be able to fit there, too, since thatprotocolis most useful in there. -
Completed
Sample code needs to be made in order to help developers see a clear picture of what's going on. These include:- A macOS and Linux console app to showcase the ability to log in, create a simple post, and view raw
Codableoutputs. - A macOS and Linux GUI app to showcase the above, but in a way that's user-friendly.
- An iOS app, showcasing how to integrate ATProtoKit into a SwiftUI project (using both the MVVM pattern, as well as the pattern Apple typically uses when showcasing SwiftUI (we're going to call it "MV" for now).
- A Linux app that demonstrates running ATProtoKit in the server for the purposes of making a bot account. The example bot will post a random emoji every minute or five minutes, depending on the user's setting).
- A macOS app that showcases how to view feeds (both logged in and logged out).
- A macOS and Linux console app to showcase the ability to log in, create a simple post, and view raw
-
Completed
Tutorials will also be made. They will include:- Creating a simple macOS or Linux console app that lets you log in, create a post, attach an external embed, and attach an image embed.
- Create an iOS GUI app to integrate ATProtoKit in a SwiftUI application (both in MVVM and MV patterns).
- Creating a server bot with logging in and creating a post.
- Creating a macOS GUI app for getting records and deleting records.
-
Completed
More articles need to be made.- Example projects that you can make with ATProtoKit
More things will be updated over time.
[!NOTE]
This will most likely be completed within the next several 0.x updates.
- Dominant language
- Swift
- Stars
- 226
- Forks
- 40
- Avg merge
- 2h 56m
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from MasterJ93/ATProtoKit
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
MasterJ93/ATProtoKit#354 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
MasterJ93/ATProtoKit#352 ·
-
[Feature Enhancement]: Add `sort` parameter to `getQuotes`Possibly taken A pull request linked to this issue is open or already merged. Openenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
MasterJ93/ATProtoKit#346 · 1 comment ·
-
[Feature Request]: Add `app.bsky.actor.contentVisibilityDeclaration` record supportPossibly taken A pull request linked to this issue is open or already merged. Opennew feature
Difficulty 3/5 1-2 days Newbie friendliness 68/100
MasterJ93/ATProtoKit#350 · 4 comments ·
-
[Feature Enhancement]: Support scoped mutes (`onlyReposts` / `onlyQuoteposts`) in `muteActor`Possibly taken A pull request linked to this issue is open or already merged. Openenhancement
Difficulty 3/5 1-2 days Newbie friendliness 72/100
MasterJ93/ATProtoKit#348 · 1 comment ·
All issues in MasterJ93/ATProtoKit
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
good first issue help wanted testing
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
area:cli documentation good first issue priority:low
Difficulty 1/5 Under an hour Newbie friendliness 94/100
isaaclins/freesnitch#430 ·
Maintainers usually reply within 1 day
-
enhancement help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
heysidhant/appvanish#4 ·
-
bug priority:low status:queued
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day