-
Notifications
You must be signed in to change notification settings - Fork 26
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.
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
PR - Webpage Updating (Intro, generated code headings, Documentation, icon) #1653
Conversation
code/website/index.html
Outdated
<h3 id="haskDoc">Haskell Documentation</h3> | ||
<p> | ||
The current documentation for the Drasil framework can be found at | ||
<a href="$docsUrl$">this link</a>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: I'm not a fan of "this link" (even though I'm occasionally guilty of doing it); maybe something like "The (link)Haddock Documentation(/link) for the Drasil framework." @JacquesCarette or @smiths may have other suggestion or preferences though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @Mornix. "this link" doesn't tell you what it is if you just scan the links. I like the Haddock Documentation suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently I have:
The current <a href="$docsUrl$">Haddock documentation</a> for the Drasil framework.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good - I completely agree that "this link" style is bad.
… to Documentation.
This PR updates the current website with a few additions.
I believe this can close the following issues: #1596, #1597, #1599, and #1633.
We can always reopen or create a new issue if something should be changed.