Skip to content

Documentation improvements#629

Merged
anakinj merged 1 commit into
jwt:mainfrom
anakinj:extend-documentation
Oct 5, 2024
Merged

Documentation improvements#629
anakinj merged 1 commit into
jwt:mainfrom
anakinj:extend-documentation

Conversation

@anakinj

@anakinj anakinj commented Oct 5, 2024

Copy link
Copy Markdown
Member

Description

Improves documentation for various apis and adds deprecation warnings to apis about to get removed.

This also adds documentation generation for the public github pages, indirect fix for #407. On every push to main the documentation would get updated.

Checklist

Before the PR can be merged be sure the following are checked:

  • There are tests for the fix or feature added/changed
  • A description of the changes and a reference to the PR has been added to CHANGELOG.md. More details in the CONTRIBUTING.md

@anakinj anakinj force-pushed the extend-documentation branch 2 times, most recently from b43ee26 to d39e486 Compare October 5, 2024 20:54
@janko

janko commented Dec 26, 2024

Copy link
Copy Markdown

@anakinj These changes break Rodauth, which references the JWT::VERSION::{MAJOR,MINOR} constants. I opened jeremyevans/rodauth#462 to switch to JWT.gem_version instead.

I was wondering if this change could possibly be reverted in the 2.x series, and delayed until 3.0. Or if at least these breaking changes could be documented in the changelog.

@anakinj

anakinj commented Dec 26, 2024

Copy link
Copy Markdown
Member Author

For sure, I'll take a peek at this

@anakinj anakinj mentioned this pull request Dec 26, 2024
2 tasks
@janko

janko commented Dec 26, 2024

Copy link
Copy Markdown

Appreciate the swift release! 🙏

@anakinj

anakinj commented Dec 27, 2024

Copy link
Copy Markdown
Member Author

Thanks for pointing this out. Think these will stay public forever to have a backwards compatible way to check the version.

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