Skip to content

Conversation

@sabine
Copy link
Collaborator

@sabine sabine commented Jan 17, 2023

Makes the documentation link on the package overview page more obvious. Somewhat addresses #826. Further improvements require a more radical change of layout.

Factors out the icons and side-box links in separate templates.

before after
Screenshot 2023-01-19 at 14-17-13 irmin 3 5 1 · OCaml Package Screenshot 2023-01-19 at 14-17-17 irmin 3 5 1 · OCaml Package
Screenshot 2023-01-19 at 14-17-54 irmin 0 9 1 · OCaml Package Screenshot 2023-01-19 at 14-17-58 irmin 0 9 1 · OCaml Package

@sabine sabine changed the title make documentation link more obvious make package documentation link more obvious Jan 17, 2023
@sabine sabine merged commit 8c2f567 into ocaml:main Jan 19, 2023
@sabine sabine deleted the more_obvious_documentation_link branch January 19, 2023 15:30
Zineb-Ada added a commit to Zineb-Ada/ocaml.org that referenced this pull request Jan 26, 2023
* make documentation link more obvious

* minor style improvement

Co-Authored-By: Sabine Schmaltz <sabine@tarides.com>
Zineb-Ada added a commit to Zineb-Ada/ocaml.org that referenced this pull request Apr 3, 2023
* make documentation link more obvious

* minor style improvement

Co-Authored-By: Sabine Schmaltz <sabine@tarides.com>
Zineb-Ada added a commit to Zineb-Ada/ocaml.org that referenced this pull request Apr 4, 2023
* make documentation link more obvious

* minor style improvement

Co-Authored-By: Sabine Schmaltz <sabine@tarides.com>
cuihtlauac added a commit that referenced this pull request Apr 6, 2023
* make package documentation link more obvious (#828)

* make documentation link more obvious

* minor style improvement

Co-Authored-By: Sabine Schmaltz <sabine@tarides.com>

* improve authors/maintainers display on package overview (#1001)

* refactor package urls, routes, and handlers (#999)

* refactor package urls, routes, and handlers
* move package redirects to redirection.ml

* Unify package overview and documentation layout (#1015)

* unified package overview/docs layout

Rearranges package overview and documentation such that:

* package_layout.eml defines the two sidebars and the
  content area
* there is a navigation element to switch between
  Overview (About) and Documentation (Docs)
* there is a placeholder element for the upcoming
  in-package search (to remind us how important
  this feature is and to show users that
  we have a plan where it goes)

Consequences:

* package overview page now has a collapsing sidebar
  with a button to slide it in on small screens
* package documentation now has a tablet (md) layout
  that shows the sidebar on-screen, instead of collapsed

* add text-sm which was lost during unification

* "Overview" instead of "About" since we have the space

* Add support for sitemap.xml

* Generate sitemap.xml by dream

* Apply suggestions from @cuihtlauac code review

Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>

* Convert lists of urls to sequences and change names of functions

* Apply suggestions from @cuihtlauac code review 2

Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>

* Delete subdomains URLs and URLs returning status code other than 200

* Apply suggestions from @cuihtlauac code review 3

Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>

* Update PR

* formating

* do not touch playground asset

* Apply suggestions from @cuihtlauac code review 4

* Apply suggestions from @cuihtlauac code review 5

* Apply suggestions from @cuihtlauac code review 6

* Apply suggestions from @cuihtlauac code review 7

* Apply suggestions from @cuihtlauac code review 8

---------

Co-authored-by: Sabine Schmaltz <sabine@tarides.com>
Co-authored-by: sabine <sabine@users.noreply.github.com>
Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>
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