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

RFC: Add banner warning when on version other than "release" #15

Open
qpwo opened this issue Sep 28, 2021 · 5 comments
Open

RFC: Add banner warning when on version other than "release" #15

qpwo opened this issue Sep 28, 2021 · 5 comments

Comments

@qpwo
Copy link

qpwo commented Sep 28, 2021

Here's a screenshot of what python's looks like:

image

@bigtimebuddy bigtimebuddy transferred this issue from pixijs/docs Sep 28, 2021
@bigtimebuddy
Copy link
Member

Great suggestion. This is a feature that would need to be added to this template.

@qpwo
Copy link
Author

qpwo commented Sep 30, 2021

In tmpl/layout.tmpl or where?

@bigtimebuddy
Copy link
Member

Yeah, probably. Since this docs template is used for a variety of projects, this feature should be opt-in. I imagine that the user defines the location of the latest docs and if the URL doesn't match, it shows the banner.

@qpwo
Copy link
Author

qpwo commented Sep 30, 2021

You opt in by providing that URL, and if that has not been provided, then you show no banner? And where exactly would that option be set in https://github.com/pixijs/pixijs ?

@bigtimebuddy
Copy link
Member

Probably somewhere here: https://github.com/pixijs/pixijs/blob/dev/webdoc.conf.json

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

No branches or pull requests

2 participants