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

[ECD 11/21] Use DocC to produce documentation #730

Closed
2 tasks
epau opened this issue Nov 30, 2022 · 8 comments
Closed
2 tasks

[ECD 11/21] Use DocC to produce documentation #730

epau opened this issue Nov 30, 2022 · 8 comments
Assignees
Labels
blocked Work is blocked on this issue for this codebase. Other labels or comments may indicate why. documentation This is a problem with documentation. feature-request A feature should be added or improved.
Milestone

Comments

@epau
Copy link
Contributor

epau commented Nov 30, 2022

Describe the feature

Previously we had used swift-doc for producing documentation. That project has since been archived and no longer maintained. We should use DocC to generate our docs.

Use Case

N/A

Proposed Solution

No response

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change
@epau epau added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Nov 30, 2022
@epau epau added this to the GA milestone Nov 30, 2022
@epau
Copy link
Contributor Author

epau commented Dec 5, 2022

  • Setup using DocC for generating docs
  • Modify generate docs script to use DocC
  • Setup github action (CI) to run doc script manually
  • Add line item to release runbook to generate docs

@epau epau removed the needs-triage This issue or PR still needs to be triaged. label Dec 5, 2022
@epau
Copy link
Contributor Author

epau commented Dec 5, 2022

Verify documentation for public code in all extensions is also generated and co-located with the extended type
#551

@epau epau self-assigned this Dec 6, 2022
@epau
Copy link
Contributor Author

epau commented Dec 14, 2022

Blocked until we figure out next steps regarding generating docs.

@epau epau added the blocked Work is blocked on this issue for this codebase. Other labels or comments may indicate why. label Dec 14, 2022
@epau epau removed their assignment Dec 14, 2022
@aalviggi
Copy link

aalviggi commented Feb 9, 2023

Hi - Please ensure the 6 Swift violations mentioned in https://quip-amazon.com/DaSJAa0p2BkC/SDK-Accessibility-Audit-2022#temp:C:YYV04ab72c49696447c82cfc8235 are addressed by this

@epau
Copy link
Contributor Author

epau commented Feb 13, 2023

Most of the work is done here (for context talk to @ganeshnj or @epau ) but there are a few quirks that need to be ironed out

@ganeshnj
Copy link
Contributor

For reference #757

@shepazon
Copy link
Contributor

shepazon commented Jul 14, 2023

FWIW I am getting tickets in the documentation issue queue about the reference being missing and about links to the reference being broken. It would be really helpful for me to at least have a rough timeframe as to when the reference will return.

@smivij smivij changed the title Use DocC to produce documentation [10/24] Use DocC to produce documentation Oct 13, 2023
@smivij smivij changed the title [10/24] Use DocC to produce documentation [ECD 10/24] Use DocC to produce documentation Oct 13, 2023
@smivij smivij changed the title [ECD 10/24] Use DocC to produce documentation [ECD 11/21] Use DocC to produce documentation Nov 14, 2023
@jbelkins
Copy link
Contributor

jbelkins commented Dec 5, 2023

Released in AWS SDK for Swift 0.32.0

@jbelkins jbelkins closed this as completed Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Work is blocked on this issue for this codebase. Other labels or comments may indicate why. documentation This is a problem with documentation. feature-request A feature should be added or improved.
Projects
None yet
Development

No branches or pull requests

5 participants