Skip to content

[Simple Linked List]: Added instruction append and hints #3026

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
Merged
merged 12 commits into from
May 23, 2022
Merged

[Simple Linked List]: Added instruction append and hints #3026

merged 12 commits into from
May 23, 2022

Conversation

BethanyG
Copy link
Member

@BethanyG BethanyG commented Apr 29, 2022 •
edited
Loading

Per discussions/questions in #3009.

Added resources, explanations, and hints for the exercise.

@github-actions

This comment was marked as resolved.

Sign in to view
@BethanyG BethanyG added the x:rep/large Large amount of reputation label Apr 29, 2022
@BethanyG BethanyG mentioned this pull request Apr 29, 2022
Closed
@BethanyG BethanyG requested review from a team and removed request for a team May 6, 2022 03:31
kotp
kotp previously requested changes May 7, 2022
View reviewed changes
Copy link
Member

@kotp kotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one statement from me, otherwise I think it looks really good!

@kotp kotp dismissed their stale review May 7, 2022 20:27

Until I can think of a way to represent in markdown that renders well for HTML also.

kotp
kotp reviewed May 7, 2022
View reviewed changes
@BethanyG BethanyG mentioned this pull request May 8, 2022
Merged
2 tasks
@BethanyG
Updated append and hints file to include svg diarams of linked list a…
4af4235 
…nd array based stacks.

Added array-stack.svg and linked-list-stack.svg files to .docs
Inserted linked-list-stack.svg and array-stack.svg into instructions append
Inserted linked-list-stack.svg into hints.md
@BethanyG BethanyG requested a review from a team May 8, 2022 18:23
@BethanyG
Copy link
Member Author

BethanyG commented May 8, 2022

@ErikSchierboom -- a few questions for you (because there is nothing I love more than being a problem child 😆 ):

  1. These .svg files were under 1MB in size, so I decided to not upload them to exercism/v3-files -- should I have uploaded them anyway?
  2. Not at all sure how I should organize or reference images in things like exercise appends and hints files. Can I ref-link images? Should the files live in an img folder in the exercise .. or be loose files?
  3. Was it OK that I referenced the .doc folder for the image used in the .meta/hints file?
  4. The images won't render in the UI right now because they aren't (yet) at the URL. Is there another way I can embed or reference them...or should I leave the links as-is?
  5. Are these better as in-line SVG? (I an guessing no)

@BethanyG BethanyG requested review from ErikSchierboom and removed request for a team May 8, 2022 18:54
@ErikSchierboom
Copy link
Member

@BethanyG Sorry, I missed in my huge list of notifications. I'll look at it next week!

ErikSchierboom
ErikSchierboom reviewed May 20, 2022
View reviewed changes
Copy link
Member

@ErikSchierboom ErikSchierboom left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These .svg files were under 1MB in size, so I decided to not upload them to exercism/v3-files -- should I have uploaded them anyway?

I'm not sure we have a policy, but the existing files there are of a similar size to the one you're uploading (see e.g. https://github.com/exercism/v3-files/blob/main/python/string-formatting/decision_tree.png), so I think uploading to v3-files makes sense.

Was it OK that I referenced the .doc folder for the image used in the .meta/hints file?

No, because the .docs and .meta folders are treated specially and their files won't be downloaded via the CLI (well, they're rendered as README.md, HELP.md and HINTS.md files).

The images won't render in the UI right now because they aren't (yet) at the URL. Is there another way I can embed or reference them...or should I leave the links as-is?

If you'll upload them to v3-files, you can reference them with a full URL: https://github.com/exercism/julia/blob/4f06b8f7ab0a67de5d817d04732ed5db1c3033bd/exercises/practice/killer-sudoku-helper/.docs/instructions.md

Are these better as in-line SVG? (I an guessing no)

No I don't think so :)

@ErikSchierboom
Copy link
Member

And sorry for the delay in replying!

@BethanyG
Copy link
Member Author

BethanyG commented May 21, 2022 •
edited
Loading

@ErikSchierboom I reopened the PR to v3_files. Do I need to wait for the v3-files PR to be approved to reference? I've zeroed out the image references in the docs in the meantime. The image PR was approved and merged, so we are good to go! Many thanks for the answers. 😄 I have notes now for the procedure for adding more diagrams, should the need arise.

@BethanyG BethanyG requested a review from kotp May 21, 2022 19:51
@BethanyG
Copy link
Member Author

Ok. I think things are finally sorted (both here, and in my brain) 😉 . Re-requesting review. Links to images should resolve now.

@BethanyG BethanyG requested a review from bobahop May 21, 2022 22:26
bobahop
bobahop approved these changes May 22, 2022
View reviewed changes
Copy link
Member

@bobahop bobahop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double-checked graphic descriptions and verified all links correctly work.

@BethanyG BethanyG merged commit 779a86c into exercism:main May 23, 2022
This was referenced Jul 14, 2022
Merged
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ErikSchierboom ErikSchierboom ErikSchierboom left review comments

@kotp kotp kotp approved these changes

@bobahop bobahop bobahop approved these changes

Assignees
No one assigned
Labels
x:rep/large Large amount of reputation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@BethanyG @ErikSchierboom @kotp @bobahop