Skip to content

[docs] Add basic documentation on using Snippets to DocC documentation #1166

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

heckj
Copy link
Member

@heckj heckj commented Mar 5, 2025

Work towards resolving #417

Summary

Adds some base line documentation that describes how to use the snippets feature built in to DocC and the DocC Plugin.

  • how to add snippets to your project
  • how to run and verify the snippets
  • how to make slices in a snippet
  • how to reference the snippet, or a slice from a snippet, from within another DocC catalog entry

Dependencies & Testing

  • no dependencies
  • visually inspected with a local preview build of the DocC documentation for testing

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests (no tests, doc updates only)
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

(this pull request is the combined work of https://github.com/JacobHearst and myself, I just happen to be submitting it)

@heckj heckj changed the title Add basic documentation on using Snippets to DocC documentation [docs] Add basic documentation on using Snippets to DocC documentation Mar 5, 2025
@d-ronnqvist d-ronnqvist added the documentation Improvements or additions to documentation label Mar 6, 2025
@d-ronnqvist
Copy link
Contributor

(this pull request is the combined work of https://github.com/JacobHearst and myself, I just happen to be submitting it)

FYI: You can coauthor commits by including a line like this in the commit message:

Co-authored-by: Jacob Hearst <[email protected]>

@heckj
Copy link
Member Author

heckj commented May 2, 2025

@JacobHearst @d-ronnqvist sorry for the delay in writing an overview. Added one based on @d-ronnqvist feedback, see what you think.

@heckj heckj requested a review from d-ronnqvist May 2, 2025 18:25
@heckj heckj force-pushed the snippets-docs branch from 6edd0fc to 9827d8b Compare May 2, 2025 21:21
@heckj
Copy link
Member Author

heckj commented May 2, 2025

@swift-ci please test

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

Successfully merging this pull request may close these issues.

2 participants