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

feat(web): adopt browser routing for cleaner URIs #911

Merged
merged 9 commits into from
Oct 28, 2024

Conversation

stevapple
Copy link
Contributor

@stevapple stevapple commented Oct 23, 2024

This PR changes docat to use browser history for routing, for simpler implementation and cleaner URIs.

BREAKING: doc and api are no longer valid project names.

Before:

https://doc.example.org/#/project/version/path%2Fto%2Fpage.html#hash

After:

https://doc.example.org/project/version/path/to/page.html#hash

Old-styled URIs will be automatically rewritten to newer ones upon loading.

@stevapple stevapple marked this pull request as draft October 23, 2024 09:38
@stevapple
Copy link
Contributor Author

Mark as draft until backward compatibility is addressed.

@stevapple stevapple marked this pull request as ready for review October 23, 2024 10:23
@randombenj randombenj self-requested a review October 23, 2024 13:42
@randombenj
Copy link
Member

randombenj commented Oct 23, 2024

Thanks for the changes @stevapple, we just had a 'facelift' of the frontend page of the UI #907, would you mind rebasing onto main before I have a look?

@stevapple
Copy link
Contributor Author

Thanks for the changes @stevapple, we just had a 'facelift' of the frontend page of the UI #907, would you mind rebasing onto main before I have a look?

Done

Copy link
Member

@randombenj randombenj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome!

docat/docat/utils.py Outdated Show resolved Hide resolved
@stevapple
Copy link
Contributor Author

@randombenj @fliiiix bother for a second review?

@randombenj randombenj merged commit 8895096 into docat-org:main Oct 28, 2024
4 checks passed
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