Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

port tutorials to DocC #28

Open
tayloraswift opened this issue Nov 17, 2024 · 0 comments
Open

port tutorials to DocC #28

tayloraswift opened this issue Nov 17, 2024 · 0 comments

Comments

@tayloraswift
Copy link
Owner

the steps for doing this are:

  1. Move the images in examples/ to directories inside Sources/JPEG/docs.docc, as this is required in order to display the images from a DocC article

    1. This will require updating a number of file paths within the example programs in Snippets/, and the scripts in utils/, as well as in the tutorials themselves
  2. Split the mega-tutorial into multiple DocC articles, with one tutorial per article

  3. Replace the https://swiftinit.org/docs/swift-jpeg hyperlinks with DocC symbol links

  4. Annotate the snippets in Snippets/ and replace the duplicated code blocks in the tutorials with DocC Snippet references

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant