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

C++ Doc improvements #4212

Merged
merged 10 commits into from
Nov 13, 2023
Merged

C++ Doc improvements #4212

merged 10 commits into from
Nov 13, 2023

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Nov 13, 2023

What

A few remaining items & polish for the C++ docs. Now uploaded to gh-pages as well on push to main (🤞 it works.......)

Commit by commit!

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation enhancement New feature or request 🌊 C++ API C/C++ API specific exclude from changelog PRs with this won't show up in CHANGELOG.md labels Nov 13, 2023
@nikolausWest
Copy link
Member

For this to actually close #3974, we also need to update the main website to link to the new hosted C++ docs. At least it should set up to do that on the next release. Is that included here? I didn't see it on a quick glance.

@Wumpf
Copy link
Member Author

Wumpf commented Nov 13, 2023

Not included yet, no. I don't know yet what to link to (see also unanswered questions on internal Slack and stuff I brought up on last standup). Right, I suppose we should keep the ticket open then until the release

@nikolausWest
Copy link
Member

I suppose we should keep the ticket open then until the release

I don't think we need to keep the ticket open until release. It should be enough to keep it open until the release is prepared somehow such that we will have links to the new docs after the release (if that means just updating the release checklist that would be OK)

.github/workflows/reusable_deploy_docs.yml Outdated Show resolved Hide resolved
.github/workflows/reusable_deploy_docs.yml Outdated Show resolved Hide resolved
.github/workflows/reusable_deploy_docs.yml Outdated Show resolved Hide resolved
@Wumpf Wumpf merged commit 23a15b5 into main Nov 13, 2023
7 of 9 checks passed
@Wumpf Wumpf deleted the andreas/cpp/doc-improvements branch November 13, 2023 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌊 C++ API C/C++ API specific 📖 documentation Improvements or additions to documentation enhancement New feature or request exclude from changelog PRs with this won't show up in CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants