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.

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

Code walkthrough #2877

Merged
merged 7 commits into from
Jan 28, 2019
Merged

Code walkthrough #2877

merged 7 commits into from
Jan 28, 2019

Conversation

paulmelnikow
Copy link
Member

@paulmelnikow paulmelnikow commented Jan 27, 2019 •
edited
Loading

Updated based on comments received in the Google Doc.

Close #2684

@paulmelnikow
Add high-level code walkthrough
a467427 
Updated based on comments received in the Google Doc.

Close #2684
@paulmelnikow
Improve formatting
48d1126
@paulmelnikow paulmelnikow added the documentation Developer and end-user documentation label Jan 27, 2019
@shields-ci
Copy link

shields-ci commented Jan 27, 2019 •
edited
Loading

Messages
📖 ✨ Thanks for your contribution to Shields, @paulmelnikow!
📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against af9c07a

@paulmelnikow paulmelnikow temporarily deployed to shields-staging-pr-2877 January 27, 2019 16:17 Inactive
chris48s
chris48s reviewed Jan 27, 2019
View reviewed changes
Copy link
Member

@chris48s chris48s left a comment

Choose a reason for hiding this comment

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

I've proposed a couple of corrections to missed links, but the content looks great.

In terms of layout, it does look a bit odd rendered with a single i. bullet under each number: https://github.com/badges/shields/blob/331799625002f2d916691788cdd411dcf2dab11a/doc/code-walkthrough.md would it look slightly more natural with a */• bullet, or does that stop the consecutive numbering from working? If so, we can leave it..

@paulmelnikow paulmelnikow temporarily deployed to shields-staging-pr-2877 January 27, 2019 21:50 Inactive
@paulmelnikow paulmelnikow temporarily deployed to shields-staging-pr-2877 January 27, 2019 22:16 Inactive
calebcartwright
calebcartwright reviewed Jan 28, 2019
View reviewed changes
doc/code-walkthrough.md Outdated
[server]: https://github.com/badges/shields/tree/master/core/server
[token-pooling]: https://github.com/badges/shields/tree/master/core/token-pooling
[services]: https://github.com/badges/shields/tree/master/services
[suggest]: https://github.com/badges/shields/tree/master/services/suggest.js
Copy link
Member

@calebcartwright calebcartwright Jan 28, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Should this be the suggest directory (it's a dead link currently)? https://github.com/badges/shields/tree/master/services/suggest

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops, it's just not moved there yet.

Copy link
Member Author

Choose a reason for hiding this comment

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

I opened #2873. Will update this to point to the pre-move file path in the meantime.

@calebcartwright
Copy link
Member

This looks good! I also need to read up on GH beta suggested changes feature... Did not know about that!

@paulmelnikow
Copy link
Member Author

would it look slightly more natural with a */• bullet, or does that stop the consecutive numbering from working? If so, we can leave it..

Yea, I'm pretty sure GitHub markdown doesn't let you nest bulleted lists inside of a numbered list.

@paulmelnikow paulmelnikow temporarily deployed to shields-staging-pr-2877 January 28, 2019 17:50 Inactive
@paulmelnikow paulmelnikow merged commit e10e8b1 into master Jan 28, 2019
@paulmelnikow paulmelnikow deleted the code-walkthrough branch January 28, 2019 21:03
@shields-deployment
Copy link

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@calebcartwright calebcartwright calebcartwright left review comments

@chris48s chris48s chris48s approved these changes

Assignees
No one assigned
Labels
documentation Developer and end-user documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@paulmelnikow @shields-ci @calebcartwright @chris48s