Skip to content

Add next and previous navigation links to all tutorials#17325

Merged
opencv-pushbot merged 1 commit intoopencv:3.4from
hunter-college-ossd-spr-2020:nav-links
May 20, 2020
Merged

Add next and previous navigation links to all tutorials#17325
opencv-pushbot merged 1 commit intoopencv:3.4from
hunter-college-ossd-spr-2020:nav-links

Conversation

@dmallia17
Copy link
Copy Markdown
Contributor

@dmallia17 dmallia17 commented May 19, 2020

This pull request adds next tutorial and previous tutorial navigation links to all main OpenCV tutorials.

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under OpenCV (BSD) License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with OpenCV
  • The PR is proposed to proper branch
  • There is reference to original bug report and related work
  • There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

@asmorkalov
Copy link
Copy Markdown
Contributor

asmorkalov commented May 20, 2020

Documentation built on CI bot: https://pullrequest.opencv.org/buildbot/export/pr/17325/docs/

@asmorkalov
Copy link
Copy Markdown
Contributor

asmorkalov commented May 20, 2020

The solution looks very suspicious. Most of links are not relevant . The tutorials are not step by step sequence of lessons and many of them should stay along. I propose to add links to previous and next to some of them that are real sequence, e.g.:

  • Android lessons (Java, no references to Closure, iOS, etc)
  • Windows with Visual Studio

@dmallia17
Copy link
Copy Markdown
Contributor Author

dmallia17 commented May 20, 2020 •
edited
Loading

Apologies but I just added connections between the existing tutorials in the order that they are in the table of contents on the live website, though I agree that some module sections do need to be reorganized and some tutorials are older/obsolete. If you don't think adding the links at this time would be helpful I can close the pull request.

@alalek
Copy link
Copy Markdown
Member

alalek commented May 20, 2020

@asmorkalov Prev/Next links are here from GSoC 2016 project (#7041) to improve navigation (according to upper level TOC). Mentioned PR covers core and imgproc modules only.
This PR extends links to other documentation areas, so it is fine.

alalek
alalek approved these changes May 20, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

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

Thank you 👍

@opencv-pushbot opencv-pushbot merged commit cb82388 into opencv:3.4 May 20, 2020
@asmorkalov
Copy link
Copy Markdown
Contributor

asmorkalov commented May 20, 2020

Thanks for the details.

This was referenced May 22, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alalek alalek alalek approved these changes

Assignees

@alalek alalek

Labels

category: documentation Documentation fix or update

Projects

None yet

Milestone

3.4.11

Development

Successfully merging this pull request may close these issues.

4 participants

@dmallia17 @asmorkalov @alalek @opencv-pushbot