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.

Sign up for GitHub

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

Jump to bottom

README, LICENSE, CHANGELOG display on package overview #985

Merged
merged 3 commits into from
Mar 20, 2023
Merged

README, LICENSE, CHANGELOG display on package overview #985

merged 3 commits into from
Mar 20, 2023

Conversation

sabine
Copy link
Collaborator

@sabine sabine commented Mar 20, 2023

  • Accompanying files (README, LICENSE, CHANGELOG) render in the package overview layout
  • Pick up README/LICENSE/CHANGELOG from their new location in the output of voodoo (these files now reside in root of package folder, instead of under doc/)
  • README now shows up next to license and changelog in the sidebar

Further refinements according to package overview redesign will happen in subsequent patches.

This patch is a prerequisite to removing the fallback to pre-odoc-2.2.0 docs.

after
Screenshot 2023-03-20 at 11-34-36 streaming 0 8 0 (latest) · OCaml Package
Screenshot 2023-03-20 at 11-34-51 streaming 0 8 0 (latest) · OCaml Package

@sabine sabine mentioned this pull request Mar 20, 2023
Merged
2 tasks
cuihtlauac
cuihtlauac approved these changes Mar 20, 2023
View reviewed changes
Copy link
Collaborator

@cuihtlauac cuihtlauac left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Silly remarks

src/global/url.ml Outdated Show resolved Hide resolved
@sabine sabine merged commit a91411d into ocaml:main Mar 20, 2023
@sabine sabine deleted the files_in_root_of_package_url branch March 20, 2023 16:58
@sabine sabine mentioned this pull request Mar 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cuihtlauac cuihtlauac cuihtlauac approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sabine @cuihtlauac