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

Standard Library documentation is broken #5176

Closed
alexporter8013 opened this issue Mar 12, 2024 · 0 comments · Fixed by #5193
Closed

Standard Library documentation is broken #5176

alexporter8013 opened this issue Mar 12, 2024 · 0 comments · Fixed by #5193
Labels
part: documentation Dafny's reference manual, tutorial, and other materials

Comments

@alexporter8013
Copy link
Contributor

alexporter8013 commented Mar 12, 2024 •
edited
Loading

What change in documentation do you suggest?

  1. In order to access the standard library documentation, you must search through the source tree to find Source/DafnyStandardLibraries and open README.md. Additionally, the link in the main readme is broken as it links to https://github.com/dafny-lang/libraries
  2. When clicking links in Source/DafnyStandardLibraries/README.md, a few of the links are broken. Examples: Std.Math, Std.Relations, and Std.Functions
  3. The links that do work point to the repository folder, instead of the markdown file for that aspect of the standard library (this part is debatable)
@alexporter8013 alexporter8013 added the part: documentation Dafny's reference manual, tutorial, and other materials label Mar 12, 2024
@alexporter8013 alexporter8013 mentioned this issue Mar 14, 2024
Merged
MikaelMayer added a commit that referenced this issue Mar 21, 2024
@alexporter8013 @MikaelMayer
Aporter/docs_fixing (#5193)
187a3b5 
### Description
Fixes #5176 

### How has this been tested?
Documentation changes only. Tested by clicking links

<small>By submitting this pull request, I confirm that my contribution
is made under the terms of the [MIT
license](https://github.com/dafny-lang/dafny/blob/master/LICENSE.txt).</small>

---------

Co-authored-by: Mikaël Mayer <MikaelMayer@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
part: documentation Dafny's reference manual, tutorial, and other materials
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Aporter/docs_fixing alexporter8013/dafny
1 participant
@alexporter8013