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

Use docc for documentation, instead of having it all in a single, giant README. #1135

Merged
merged 3 commits into from
Mar 30, 2024

Conversation

younata
Copy link
Member

@younata younata commented Mar 30, 2024

Nimble's documentation was previously mostly in the README. Jesse Squires helped a lot by adding autogenerated docs using Jazzy, but that didn't fix the problem of the giant README, that includes installation instructions at the bottom.

DocC is not as nice as Jazzy for autogenerated docs, but for human-written documentation, it's pretty nice. 8/10. This PR migrates our documentation to DocC, for easier consumption.

There's a lot of follow-up work after this is done to further improve Nimble's documentation, but this is an great starting point just in terms of improving the chances that people's eyes won't glaze over at the giant README.

  • This PR doesn't require a new version of Nimble to go out.

@younata younata merged commit e617085 into main Mar 30, 2024
15 of 16 checks passed
@younata younata deleted the use_docc_for_documentation branch March 30, 2024 22:01
cgrindel-self-hosted-renovate bot referenced this pull request in cgrindel/rules_swift_package_manager Apr 9, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [Quick/Nimble](https://togithub.com/Quick/Nimble) | minor | `from:
"13.2.1"` -> `from: "13.3.0"` |

---

### Release Notes

<details>
<summary>Quick/Nimble (Quick/Nimble)</summary>

### [`v13.3.0`](https://togithub.com/Quick/Nimble/releases/tag/v13.3.0)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v13.2.1...v13.3.0)

### Highlights

- Adds Matchers for Result that match against submatchers or equatable
values.
-   Use DocC for documentation.
-   Make `PollingDefaults` threadsafe.

#### What's Changed

- Make PollingDefaults threadsafe by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1122](https://togithub.com/Quick/Nimble/pull/1122)
- Bump softprops/action-gh-release from 1 to 2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1128](https://togithub.com/Quick/Nimble/pull/1128)
- Depend on CwlPreconditionTesting 2.2.0 for Cocoapods by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1129](https://togithub.com/Quick/Nimble/pull/1129)
- Add matchers for Result that match against submatchers, or for
equatable values. by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1134](https://togithub.com/Quick/Nimble/pull/1134)
- Use docc for documentation, instead of having it all in a single,
giant README. by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1135](https://togithub.com/Quick/Nimble/pull/1135)
- Get documentation deploying working. by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1136](https://togithub.com/Quick/Nimble/pull/1136)
- Improve documentation articles by adding short abstracts to them. by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1137](https://togithub.com/Quick/Nimble/pull/1137)
- Fix a typo in the name of this framework. 🤦🏻‍♀️ by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1138](https://togithub.com/Quick/Nimble/pull/1138)
- Bump actions/checkout from 3 to 4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1139](https://togithub.com/Quick/Nimble/pull/1139)

**Full Changelog**:
Quick/Nimble@v13.2.1...v13.3.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMDkuNCIsInVwZGF0ZWRJblZlciI6IjM2LjEwOS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: Self-hosted Renovate Bot <361546+cgrindel-self-hosted-renovate[bot]@users.noreply.github.enterprise.com>
noamfreeman pushed a commit to noamfreeman/Nimble that referenced this pull request Oct 14, 2024
…nt README. (Quick#1135)

* Migrate Nimble's documentation to a DocumentCatalog

* Remove autogenerated docs

* Build docs as part of github
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.

1 participant