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

docs(rpc): remaining v21.0.0 rpc updates #109

Merged
merged 9 commits into from
Aug 8, 2024

Conversation

thephez
Copy link
Collaborator

@thephez thephez commented Aug 7, 2024

@thephez thephez merged commit e29e558 into dashpay:21.0.0 Aug 8, 2024
1 check passed
@thephez thephez deleted the v21.0.0-rpc-updates-2 branch August 8, 2024 14:28
@riongull
Copy link

riongull commented Aug 8, 2024

Do these "v21.0.0" docs updates include the changes for "v21.1.0" (if any)?

If we don't have docs updates on minor or patch versions would it be better to call them "v21" instead?

@thephez
Copy link
Collaborator Author

thephez commented Aug 8, 2024

This PR doesn't include 21.1 changes, although I don't see are any related to RPCs (dashpay/dash@v21.0.0...dashpay:v21.1.0).

As for the branch name, readthedocs (which builds/hosts the content) expects a semver "x.y.z" format for automatically recognizing what to direct people to as the default docs. For example, when you go to docs.dash.org it directs you to https://docs.dash.org/en/stable/ which is the same as if you chose 21.0.0 from the version selector. So v21 might be better, but there are some constraints in play 🙂

image.

@riongull
Copy link

riongull commented Aug 8, 2024

Yeah, I've seen the selector on the website, which is why I'm asking follow up questions. It seems to only show major versions like v19.0.0, v20.0.0, etc, so it makes me wonder if v20.0.0 docs are really for the latest v20 docs or literally for v20.0.0. Is there (or will there be) any difference between "latest", v21.0.0, and v21.1.0 (if there will eventually be a separate docs page for that).

If you can change the text to v19, v20, v21, etc on the dropdown I think that would be more clear (if in fact they represent minor and patch updates), but I'm mostly just trying to understand how it works so I know what im looking at on any given page.

@thephez
Copy link
Collaborator Author

thephez commented Aug 12, 2024

Since Core is now following semver pretty closely, expect to typically just see 21.0.0, 22.0.0, etc. Minor/patch releases should not be making changes significant enough to require a new version of docs. So when you see "X.0.0", assume they're good for all of "vX". In the future if there were a minor/patch version of docs it would likely be due to a deviation in Core's semver that significantly changed something. I don't anticipate Pasta doing that though 🙂

Regarding the dropdown text... Based on a cursory look, readthedocs directly uses the branch/tag name as the text in the dropdown. I didn't see an option for customizing it.

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.

2 participants