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.

Sign up for GitHub

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

Jump to bottom

Fix private docs #326

Merged
merged 4 commits into from
Dec 22, 2023
Merged

Fix private docs #326

merged 4 commits into from
Dec 22, 2023

Conversation

tyranron
Copy link
Collaborator

@tyranron tyranron commented Dec 22, 2023 •
edited
Loading

Synopsis

We do have quite a rich private documentation, which helps to understand and navigate code. However, it has never been checked on CI, so many intra-doc links are just broken.

Solution

  • Check private Rust docs on CI to build OK.
  • Fix the broken intra-doc links in private docs.

Checklist

  • Documentation is updated (fixed)
  • Tests are added/updated (CI check)
  • CHANGELOG entry is added (not required)

@tyranron tyranron added docs github_actions Pull requests that update GitHub Actions code labels Dec 22, 2023
@tyranron tyranron added this to the 1.0.0 milestone Dec 22, 2023
@tyranron tyranron self-assigned this Dec 22, 2023
@tyranron tyranron requested a review from JelteF December 22, 2023 14:00
@tyranron tyranron marked this pull request as ready for review December 22, 2023 14:00
@tyranron tyranron merged commit 44edc0c into master Dec 22, 2023
17 checks passed
@tyranron tyranron deleted the fix-private-docs branch December 22, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelteF JelteF JelteF approved these changes

Assignees

@tyranron tyranron

Labels
docs github_actions Pull requests that update GitHub Actions code
Projects
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@tyranron @JelteF