rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity

Improve the DocC documentation #14

New Issue
Closed
opened 2023-04-24 15:51:55 +00:00 by javier · 0 comments
javier commented 2023-04-24 15:51:55 +00:00
Owner
Copy Link

Currently, the DocC documentation is being generated out of a minimal, standard template defined by Xcode. Although this is good to start, it is definitely not an optimal experience for any developer that would be looking forward to using the package.

So, to improve this documentation it is recommended to:

  1. create a Getting Started article that explains how to install the library in your project and how to set the service properly to start using it right away;
  2. grouped the public components based on their type and use: service, filters, models, and errors.
  3. improve the landing screen to display this flattened hierarchy and to provide quick access to the other articles and reference documentation.

Feel free to use some inspiration from these resources:

Currently, the DocC documentation is being generated out of a minimal, standard template defined by Xcode. Although this is good to start, it is definitely not an optimal experience for any developer that would be looking forward to using the package. So, to improve this documentation it is recommended to: 1. create a **Getting Started** article that explains how to install the library in your project and how to set the service properly to start using it right away; 2. grouped the public components based on their type and use: *service*, *filters*, *models*, and *errors*. 3. improve the landing screen to display this flattened hierarchy and to provide quick access to the other articles and reference documentation. Feel free to use some inspiration from these resources: * [Apple DocC sample code](https://developer.apple.com/documentation/xcode/slothcreator_building_docc_documentation_in_xcode); * [Improve the discoverability of your Swift-DocC content](https://developer.apple.com/wwdc22/110369); * [Elevate your DocC documentation in Xcode](https://developer.apple.com/wwdc21/10167).
javier added this to the Post-release maintenance milestone 2023-04-24 15:51:55 +00:00
javier self-assigned this 2023-04-24 15:51:55 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
Something is not working
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
question
More information is needed
wontfix
This won't be fixed
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone Post-release maintenance
Assignees
Clear assignees
No Assignees javier
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rock-n-code/amiibo-service#14
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?