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.

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

Merged
merged 22 commits into from
Jul 10, 2019

Conversation

danscime
Copy link
Collaborator

@danscime danscime commented Jul 2, 2019

This PR updates the current website with a few additions.

  • Icon added to webpage.
  • "Generated Code" headings only added if there are source code folders for the example.
  • Adding an intro paragraph to briefly describe Drasil.
  • Adding a brief description for the Haskell Documentation section.

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.

code/website/site.hs Outdated Show resolved Hide resolved
code/website/site.hs Outdated Show resolved Hide resolved
code/website/site.hs Outdated Show resolved Hide resolved
<h3 id="haskDoc">Haskell Documentation</h3>
<p>
The current documentation for the Drasil framework can be found at
<a href="$docsUrl$">this link</a>.
Copy link
Collaborator

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.

Copy link
Collaborator

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.

Copy link
Collaborator Author

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.

Copy link
Owner

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.

code/scripts/deploy_stage.sh Outdated Show resolved Hide resolved
code/scripts/deploy_stage.sh Outdated Show resolved Hide resolved
code/website/index.html Outdated Show resolved Hide resolved
@JacquesCarette JacquesCarette merged commit a4e1865 into master Jul 10, 2019
@JacquesCarette JacquesCarette deleted the webpageCode branch July 10, 2019 14:03
@Mornix Mornix mentioned this pull request Jul 10, 2019
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.

5 participants