Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) #3705

daijingz · 2024-03-26T04:05:08Z

@samm82 Wait a moment for the new updates.
Inherited from previous PR #3686, but with some changes. Please wait for some further checks.
Corresponding Issue: #3360

Newest inspection: Coding style requirements.

Double spaces of indent levels.
Camel case variable names
Correct meaningful variable names.
Single blank lines between top-level objects.

JacquesCarette

The changes to the Website are far from pretty... but at (unfortunately) quite consistent with just how bad this code is. So those two changes are ok. Just the change to README needs improved.

JacquesCarette · 2024-03-26T16:37:01Z

README.md

@@ -21,7 +21,7 @@ Generate all the Things! Visit [our website](https://jacquescarette.github.io/Dr

 ## What is Drasil?

-For well understood domains, building software ought to be a matter of engineering, based on solid scientific foundations. The ultimate test of "well understood" is being able to teach the domain language to a computer.  Drasil is a framework for generating all of the software artifacts for (well understood) research software, from the natural knowledge base of the domain.
+For well understood domains, building software ought to be a matter of engineering, based on solid scientific foundations. The ultimate test of "well understood" is being able to teach the domain language to a computer.  Drasil is a framework for generating all of the software artifacts for (well understood) research software, from the natural knowledge base of the domain. The exhaustive summary of [well-understood](https://github.com/JacquesCarette/Drasil/blob/master/Papers/WellUnderstood/wu.pdf) domains and our original ideas include Drasil's primary information.


Rather than this, I would make "(well understood) research software" in the previous line be a link to the paper, and skip this whole new sentence.

samm82 · 2024-03-26T18:40:44Z

Also @daijingz, it's better to make any changes in a branch on your fork so that you don't need to "revert" your changes on your master branch, effectively removing your work from the PR (like in #3686).

daijingz · 2024-03-27T17:51:09Z

Also @daijingz, it's better to make any changes in a branch on your fork so that you don't need to "revert" your changes on your master branch, effectively removing your work from the PR (like in #3686).

There are two existing branches in my personal machine for other issues, and I will use your described tools.
@JacquesCarette sorry for concerns, I will improve in the future.

samm82 · 2024-04-01T21:19:03Z

code/drasil-website/lib/Drasil/Website/About.hs

+  namedRef icsePositionPaper (S "Old Position Paper") +:+ S "outlining our original ideas, a" +:+ 
+  namedRef danPoster (S "Drasil Poster") +:+ S ", and a" +:+ 
+  namedRef wellUnderstoodPaper (S "Well-Understood Paper") +:+ S "discussing key concepts."


This should use foldlList, or something similar. I seem to remember describing how to do this, as well as some other improvements, in a previous PR; you can use that as reference!

daijingz · 2024-04-09T05:27:44Z

Sorry everyone, there are some non-personal issues taking place on my PC, and I am going to go to repair stores tomorrow. I will get back tomorrow.

daijingz · 2024-04-17T18:00:34Z

@samm82 Newest update: have built two reusable wiki page sentences. This modification has some naming problems, and I am checking.

For the foldlList, I did not find some relevant code sections in the same program file. There is an example in this program file, however, it was used to represent an object list, where each hyperlink is separated by commas. However, this cannot work perfectly in the paragraph, as you can see, the input of foldlList has two input types: hyperlinks and sentences but this function can only have one type.

Can you show me the corresponding foldlList PR?

daijingz · 2024-04-17T18:07:18Z

Up to now my PR has a lot of commits, do not worry, later I will git rebase.

code/drasil-website/lib/Drasil/Website/About.hs

samm82 · 2024-04-17T19:34:29Z

For the foldlList, I did not find some relevant code sections in the same program file. There is an example in this program file, however, it was used to represent an object list, where each hyperlink is separated by commas. However, this cannot work perfectly in the paragraph, as you can see, the input of foldlList has two input types: hyperlinks and sentences but this function can only have one type.

Can you show me the corresponding foldlList PR?

@daijingz You should search the repo for "foldlList" to find how its used. If you can't find a PR/discussion about it (I think your git usage led to some of your work being overwritten), just search the codebase to see examples of how it's used.

daijingz · 2024-04-22T04:34:39Z

For the foldlList, I did not find some relevant code sections in the same program file. There is an example in this program file, however, it was used to represent an object list, where each hyperlink is separated by commas. However, this cannot work perfectly in the paragraph, as you can see, the input of foldlList has two input types: hyperlinks and sentences but this function can only have one type.
Can you show me the corresponding foldlList PR?

@daijingz You should search the repo for "foldlList" to find how its used. If you can't find a PR/discussion about it (I think your git usage led to some of your work being overwritten), just search the codebase to see examples of how it's used.

Before I notice there is an example on the second paragraph:

For tonight's update, I use foldlList Comma List here, I guess this is the expected situation. @samm82
@JacquesCarette @balacij After reading some Wiki documentation, I have added some supplemental information for this PR. I realized the provided information's incompleteness.

code/stable-website/index.html

code/drasil-website/lib/Drasil/Website/About.hs

samm82 · 2024-05-13T17:54:05Z

code/drasil-website/lib/Drasil/Website/About.hs

+aboutParagraph9 papersWiki icsePositionPaper danPoster wellUnderstoodPaper = 
+  S "A list of papers and documents written about Drasil can be found on the" +:+
+  namedRef papersWiki (S "Drasil papers and documents") +:+. wikiSentence +:+


I previously asked if "papers" and "documents" should be capitalized; I now realize that "Drasil Papers and Documents" is the name of the wiki page being referenced here, so they should be capitalized. Other than this, this PR looks good to me!

daijingz · 2024-05-15T18:43:12Z

@samm82 Today I realized that webpage text inconsistencies may become a problem, so I inspected the existing text in the website to find any possible improvement places.

Scope: the whole About section. (Code is in About.hs)
Possible improvement places: 3

useage -> usage
up to date -> up-to-date
shows -> show

These are Grammarly suggestions. If you feel there is no need to change this, I can stay without any further changes, but I suggest modifying these words.

samm82

Super minor nitpick, but this looks good to me! We should wait on Dr. Carette's review though.

samm82 · 2024-05-17T04:04:48Z

code/drasil-website/lib/Drasil/Website/About.hs

  \a specific purpose so that knowledge may be used in generated models, definitions, and theories. Chunks are usually made up of several \
  \lower-level types that hold lower-lever information; when contained together, these pieces of lower-level information hold a new specific \
  \purpose. The structure of a chunk can be thought of as a wrapper of information, and this is all implemented using Haskell's record-type \
  \syntax. Recipes transform the acquired knowledge into a usable format."

 -- | Paragraph describing recipes
 aboutParagraph7 :: Reference -> Sentence
-aboutParagraph7 recipesWiki= S "As described in the" +:+ namedRef recipesWiki (S "Recipes") +:+ S "wiki page, recipes are instructions that \
-  \unpackage necessary information from chunks and send \
+aboutParagraph7 recipesWiki= S "As described in the" +:+ namedRef recipesWiki (S "Recipes") +:+ 


Suggested change

aboutParagraph7 recipesWiki= S "As described in the" +:+ namedRef recipesWiki (S "Recipes") +:+

aboutParagraph7 recipesWiki = S "As described in the" +:+ namedRef recipesWiki (S "Recipes") +:+

daijingz · 2024-06-03T04:59:54Z

Let me think about more possible improvements. (Updating)

daijingz added 16 commits January 22, 2024 17:16

JacquesCarette#3360

03748eb

Merge branch 'master' of https://github.com/daijingz/Drasil

9af6495

Merge branch 'JacquesCarette:master' into master

a876566

Update README.md

d386d30

Merge branch 'JacquesCarette:master' into master

a76d086

JacquesCarette#3686

f9441cf

JacquesCarette#3686

e9152a9

JacquesCarette#3686

493a655

JacquesCarette#3686

7ad852e

Merge branch 'JacquesCarette:master' into master

fa57c6c

Merge branch 'JacquesCarette:master' into master

eb2d515

Update About.hs

7faccf6

JacquesCarette#3686

2446d85

JacquesCarette#3360

362da84

Merge branch 'master' of https://github.com/daijingz/Drasil

1d5470b

Merge branch 'JacquesCarette:master' into master

dbd8c79

daijingz requested a review from JacquesCarette as a code owner March 26, 2024 04:05

JacquesCarette requested changes Mar 26, 2024

View reviewed changes

Update README.md

54a6b57

daijingz requested a review from JacquesCarette March 27, 2024 17:51

samm82 requested changes Apr 1, 2024

View reviewed changes

daijingz added 3 commits April 12, 2024 21:34

Merge branch 'JacquesCarette:master' into master

165e752

Update About.hs

c078bae

Update index.html

68dd414

samm82 requested changes Apr 17, 2024

View reviewed changes

code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved

code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved

daijingz changed the title ~~Should add Well-Understood paper to front page description #3360 (Attempt)~~ Resolved: Should add Well-Understood paper to front page description #3360 (Attempt) Apr 22, 2024

daijingz changed the title ~~Resolved: Should add Well-Understood paper to front page description #3360 (Attempt)~~ Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) Apr 22, 2024

JacquesCarette#3360

208809e

daijingz requested a review from samm82 April 22, 2024 15:33

Merge branch 'JacquesCarette:master' into master

e33c1c3

samm82 requested changes Apr 29, 2024

View reviewed changes

code/stable-website/index.html Outdated Show resolved Hide resolved

code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved

daijingz added 2 commits May 13, 2024 00:14

Merge branch 'JacquesCarette:master' into master

902b299

JacquesCarette#3705

8718bc0

daijingz requested a review from samm82 May 13, 2024 04:56

samm82 requested changes May 13, 2024

View reviewed changes

JacquesCarette#3705

81a37f0

samm82 approved these changes May 17, 2024

View reviewed changes

daijingz added 3 commits May 17, 2024 01:51

Merge branch 'JacquesCarette:master' into master

8329b26

Merge branch 'JacquesCarette:master' into master

612f74f

JacquesCarette#3360

0166340

daijingz requested a review from samm82 June 3, 2024 04:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) #3705

Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) #3705

daijingz commented Mar 26, 2024 •

edited

JacquesCarette left a comment

JacquesCarette Mar 26, 2024

samm82 commented Mar 26, 2024

daijingz commented Mar 27, 2024 •

edited

samm82 Apr 1, 2024

daijingz commented Apr 9, 2024

daijingz commented Apr 17, 2024 •

edited

daijingz commented Apr 17, 2024

samm82 commented Apr 17, 2024

daijingz commented Apr 22, 2024 •

edited

samm82 May 13, 2024

daijingz commented May 15, 2024 •

edited

samm82 left a comment

samm82 May 17, 2024

daijingz commented Jun 3, 2024 •

edited

	aboutParagraph7 recipesWiki= S "As described in the" +:+ namedRef recipesWiki (S "Recipes") +:+
	aboutParagraph7 recipesWiki = S "As described in the" +:+ namedRef recipesWiki (S "Recipes") +:+

Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) #3705

Are you sure you want to change the base?

Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) #3705

Conversation

daijingz commented Mar 26, 2024 • edited

JacquesCarette left a comment

Choose a reason for hiding this comment

JacquesCarette Mar 26, 2024

Choose a reason for hiding this comment

samm82 commented Mar 26, 2024

daijingz commented Mar 27, 2024 • edited

samm82 Apr 1, 2024

Choose a reason for hiding this comment

daijingz commented Apr 9, 2024

daijingz commented Apr 17, 2024 • edited

daijingz commented Apr 17, 2024

samm82 commented Apr 17, 2024

daijingz commented Apr 22, 2024 • edited

samm82 May 13, 2024

Choose a reason for hiding this comment

daijingz commented May 15, 2024 • edited

samm82 left a comment

Choose a reason for hiding this comment

samm82 May 17, 2024

Choose a reason for hiding this comment

daijingz commented Jun 3, 2024 • edited

daijingz commented Mar 26, 2024 •

edited

daijingz commented Mar 27, 2024 •

edited

daijingz commented Apr 17, 2024 •

edited

daijingz commented Apr 22, 2024 •

edited

daijingz commented May 15, 2024 •

edited

daijingz commented Jun 3, 2024 •

edited