Adding links to the landing page #2460
Conversation
Co-authored-by: Fabio Madge <[email protected]>
…to cok-docs-reorg
docs/index.md
Outdated
|
|
||
| **Quick Links:** | ||
| - [Dafny Reference Manual and User Guide](DafnyRef/DafnyRef) | ||
| - [Index to Dafny Resources for Users](toc) ([installation](https://github.com/dafny-lang/dafny/wiki/INSTALL)) ([Dafny for VSCode](https://marketplace.visualstudio.com/items?itemName=dafny-lang.ide-vscode)) |
There was a problem hiding this comment.
| - [Index to Dafny Resources for Users](toc) ([installation](https://github.com/dafny-lang/dafny/wiki/INSTALL)) ([Dafny for VSCode](https://marketplace.visualstudio.com/items?itemName=dafny-lang.ide-vscode)) | |
| - [Index to Dafny Resources for Users](toc) | |
| - Install Dafny using the Visual Studio Code [extension](https://marketplace.visualstudio.com/items?itemName=dafny-lang.ide-vscode) |
There was a problem hiding this comment.
If we are going to include installation for VSCode here, why not a link to the installation page itself? -- not everyone uses VSCode.
There was a problem hiding this comment.
Very true, but in my mind, this page doesn't target everyone, but people new to Dafny, who just want to get started. I don't want to overwhelm them with a plethora of options.
There was a problem hiding this comment.
Right -- so some new person comes to the page -- Linux or Mac user - and wonders how to install. Really? I have to use VSCode? I've never used it before! That's Microsoft! How about a command-line? or emacs?
There was a problem hiding this comment.
I'm not saying that those user don't exist, but I trust them to find what they're looking for themselves.
There was a problem hiding this comment.
A definite positive improvement, thanks! We should continue to beef up and polish dafny.org to the point where it can replace the GitHub page as the primary landing page.
I notice that on https://davidcok.github.io/dafny/ there is a "Dafny Documentation" header on every page. Can we remove that or change it to something broader such as just "Dafny"? I feel labelling it as the "documentation website" is under-selling it.
DRC: Changed to header to "Dafny". Turns out Github will generate a header for you if you don't have one. Added an issue to figure out how to convince Github to not display it.
docs/HowToFAQ/index.md
Outdated
|
|
||
| These pages are not intended to be a reference manual or an organized tutorial for Dafny. | ||
|
|
||
| If you have questions that are not addressed here, be sure to communicate them to the Dafny team. |
There was a problem hiding this comment.
The meaning of "the Dafny team" isn't super obvious, how about "cut an issue or start a discussion on GitHub" (with links)?
I see this is dead content now, so this is more of a future note instead. :)
There was a problem hiding this comment.
I am about to start organizing and editing that page, so I'll make that change.
| @@ -0,0 +1,43 @@ | |||
| --- | |||
| title: The Dafny Language and Software Verification System | |||
There was a problem hiding this comment.
| title: The Dafny Language and Software Verification System | |
| title: The Dafny Language |
Dafny is a programming language first and foremost, not a tool meant to verify software written in other languages. It may be possible to apply it to the latter use case, but that's secondary.
There was a problem hiding this comment.
By "Software Verification System" I meant the tools used to check/compile etc. Dafny programs. The project is not just language design -- it is tool development for that language.
There was a problem hiding this comment.
Fair enough, but IMO the main dafny.org front page should be primarily focussed on Dafny users rather than Dafny tool developers. We can have subpages dedicated to developing Dafny itself.
We could have something like "The Dafny Verified Programming Language" if we wanted to emphasize what makes Dafny unique.
There was a problem hiding this comment.
I agree fully that dafny.org is for users (the dafny GitHub project and wiki are for developers). But the users are using the tools, not just learning the language.
docs/HowToFAQ/index.md
Outdated
| If you have questions that are not addressed here, be sure to communicate them to the Dafny team. | ||
|
|
||
| This is just a placeholder for now, but we are working on this material. | ||
|
|
There was a problem hiding this comment.
No let's not check in dead content, same as we shouldn't be checking in commented out code.
|
Obsoleted |
Adding links to the landing page and moving it into dafny.git.
Pages can be previewed at davidcok.github.io/dafny.
This is not yet the reorg to obsolete dafny.github.io and tie pages to releases
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.