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

Update readme and URLs #350

Merged
merged 7 commits into from
Oct 29, 2024
Merged

Update readme and URLs #350

merged 7 commits into from
Oct 29, 2024

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Oct 28, 2024

The important thing from this PR is that we need to update the URLs (after the repo name changed) so that the nodes that are published on nuget are linked to the actual docs site. Currently the "F1" Help functionality doesn't work for our nodes. I think this should fix that.

I also added some instructions to the README to document how to setup breakpoints in Visual Studio.

@cjsha cjsha requested review from jonnew and bparks13 October 28, 2024 01:59
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@jonnew jonnew left a comment

Choose a reason for hiding this comment

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

Instead of random snippets with no context:

image image

Just show the compete dialog with steps labelled as in the original image in this readme, or no labels if its obvious

Copy link
Member

@bparks13 bparks13 left a comment

Choose a reason for hiding this comment

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

I addressed all of the comments by @jonnew, and I updated the version number so that the actions would pass.

However, I noticed that in the build-and-run.png file, there is only the numbers for 3 and 4. Did we change the image?

- Provide context for screenshots by adding labels
  that correspond to numbered bullet points in the
  written content
@cjsha
Copy link
Member Author

cjsha commented Oct 28, 2024

I haven't changed build-and-run.png. I just moved it to a different images folder. In any case, I think the way it is makes sense - labels 3 & 4 correspond to bullet points 3 & 4 of the "Run in visual studio" section. I'm not sure bullet points 1 & 2 need screenshots w/ labels.

I don't think we had it like jon does in the "Enable Debugging" section that we'd created. In the latest commit, I try to amend that.

Thanks for addressing his comments @bparks13

@cjsha cjsha requested review from jonnew and bparks13 October 29, 2024 01:47
Copy link
Member

@bparks13 bparks13 left a comment

Choose a reason for hiding this comment

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

Everything looks good to me now, but there are a few commits going back and forth; before merging to main, I would recommend someone go through and squash commits together to clean up the history

- Minor changes
@jonnew
Copy link
Member

jonnew commented Oct 29, 2024

@cjsha please squash and merge

@cjsha cjsha merged commit 634a54c into main Oct 29, 2024
7 checks passed
@bparks13 bparks13 deleted the update-README-and-URLs branch October 30, 2024 17:59
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.

3 participants