Skip to content

[Feature] Add Basic DocC Documentation Support #5

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

Merged
merged 1 commit into from
Nov 11, 2021

Conversation

Kyle-Ye
Copy link
Contributor

@Kyle-Ye Kyle-Ye commented Oct 17, 2021

Summary

After upgrading the Swift version, we can use DocC to document the Markdown module.

So this PR add a .docc file in Markdown module, add basic DocC support and move the original ./Documentation/BlockDirectives.md to the DocC Hierarchy

Checklist

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

  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@Kyle-Ye Kyle-Ye force-pushed the feature/documentation branch 2 times, most recently from 8be8d45 to 00c1e93 Compare October 24, 2021 06:07
Copy link
Contributor

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for posting this! This is a great start to having docs for swift-markdown. I just want to make some small edits, and then this can be ready to go, even though this is a "WIP". I think it's useful to merge so we can use it as a baseline to build up documentation for Swift-Markdown over time. I also want to wait until #4 is landed, so we can use that work to enable the doc catalog.

@Kyle-Ye Kyle-Ye force-pushed the feature/documentation branch from 00c1e93 to 1ab1998 Compare October 30, 2021 02:52
@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Oct 30, 2021

Thanks so much for posting this! This is a great start to having docs for swift-markdown. I just want to make some small edits, and then this can be ready to go, even though this is a "WIP". I think it's useful to merge so we can use it as a baseline to build up documentation for Swift-Markdown over time. I also want to wait until #4 is landed, so we can use that work to enable the doc catalog.

Update with your suggestion.

@Kyle-Ye Kyle-Ye marked this pull request as ready for review October 30, 2021 02:54
@Kyle-Ye Kyle-Ye changed the title [WIP/Feature] Add Basic DocC Documentation Support [Feature] Add Basic DocC Documentation Support Nov 2, 2021
@Kyle-Ye Kyle-Ye force-pushed the feature/documentation branch from 1ab1998 to 441a750 Compare November 2, 2021 11:46
@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Nov 2, 2021

Thanks so much for posting this! This is a great start to having docs for swift-markdown. I just want to make some small edits, and then this can be ready to go, even though this is a "WIP". I think it's useful to merge so we can use it as a baseline to build up documentation for Swift-Markdown over time. I also want to wait until #4 is landed, so we can use that work to enable the doc catalog.

The swift bump version PR #4 is merged into main. And I rebased the branch. It should pass the Linux Test now. Could we run test again on this and merge it if passing the tests? @QuietMisdreavus

@Kyle-Ye Kyle-Ye force-pushed the feature/documentation branch from 441a750 to f9e45ab Compare November 2, 2021 12:13
@QuietMisdreavus
Copy link
Contributor

@swift-ci Please test

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Nov 3, 2021

I think we need to pending this PR until #13 is merged.

Copy link
Contributor

@ethan-kusters ethan-kusters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks amazing! Thanks for getting things started here.

@Kyle-Ye Kyle-Ye force-pushed the feature/documentation branch from f9e45ab to 0313461 Compare November 11, 2021 03:23
@ethan-kusters
Copy link
Contributor

@swift-ci please test

Copy link
Contributor

@ethan-kusters ethan-kusters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Thank you @Kyle-Ye!

Copy link
Contributor

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks so much!

@ethan-kusters ethan-kusters merged commit c570b58 into swiftlang:main Nov 11, 2021
@Kyle-Ye Kyle-Ye deleted the feature/documentation branch November 12, 2021 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants