Skip to content

Link to last working doc #1096

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

Closed
wants to merge 7 commits into from
Closed

Link to last working doc #1096

wants to merge 7 commits into from

Conversation

AliasQli
Copy link
Contributor

@AliasQli AliasQli commented Jul 8, 2022

This pull request implements issue #668 as an GSoC project, mentored by @gbaz. It adds an indicator for each package version with a working doc. It looks like this, where version 0.1.0 has doc but 0.1.1 not:

Screenshot_20220708_164253

Actually I'm not very satisfied with the UI and am expecting a better idea.

This is my first time contributing here, so if I did something wrong in code style or structure please point it out.

@AliasQli
Copy link
Contributor Author

AliasQli commented Jul 8, 2022

Now I changed the UI and this time it's much better. When the current version doesn't have a doc built, it tries to find the greatest version with a working doc that is not depcrated. Screensoht:

2

@AliasQli AliasQli changed the title Add doc indicator Link to last working doc Jul 8, 2022
@gbaz
Copy link
Contributor

gbaz commented Jul 8, 2022

I think that find code is correct. However, I think the link should not be in the versions listing.

Rather, it should be either above or below the modules listing in the main pane, not the sidebar. (As the modules listing is where people would click through to get the docs, should they exist:

image

Additionally, maybe the redirect for docs, as described in this issue, could pick last working docs: #1095

@AliasQli
Copy link
Contributor Author

AliasQli commented Jul 8, 2022

The described redirect for docs is added. Now DocumentationFeature depend on VersionsFeature, since it has to find out the package status. Unpreferred versions are also excluded from redirection. Will work on UI tomorrow.

@AliasQli
Copy link
Contributor Author

AliasQli commented Jul 9, 2022

Screenshot:

3

@gbaz
Copy link
Contributor

gbaz commented Dec 31, 2022

was accidentally included in #1116 and hence already merged

@gbaz gbaz closed this Dec 31, 2022
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