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

Link to and explain examples #463

Closed
crandmck opened this issue Oct 12, 2015 · 10 comments
Closed

Link to and explain examples #463

crandmck opened this issue Oct 12, 2015 · 10 comments
Assignees

Comments

@crandmck
Copy link
Member

https://github.com/strongloop/express/tree/master/examples is an important resource that we should highlight in the docs. We should link to it from appropriate places, and it might make sense to provide an "index" into the examples explaining what each is and for the more important ones, explicate some of the code.

@crandmck crandmck added the docs Issues/pr concerning content label Oct 12, 2015
@hacksparrow
Copy link
Member

How about a new menu titled "Examples"?

@hacksparrow
Copy link
Member

The menu items would be links to the respective example directories.

@crandmck
Copy link
Member Author

I don't think that would work because there are 20+ examples. I think we need a description of each example, and in some cases text to explicate the example code. Let's discuss.

@crandmck
Copy link
Member Author

Also, have all these examples been updated for 5.x? @dougwilson

@dougwilson
Copy link
Contributor

The main reason the examples are in the main Express repo is because they actually all run as part of the CI testing. The ones that would be updated for 5.x would be on the 5.0 branch in GitHub (but to my memory, all the ones in master work without modifications in Express 5 anyway).

@hacksparrow
Copy link
Member

Maybe a link titled "Examples" under "Resources"? This page would list the links to the examples with a brief description of each example.

@crandmck
Copy link
Member Author

@hacksparrow Yes, that is basically what I was thinking of. Also, if any of the examples are relevant to guide articles or even API sections we should then xref to the appropriate example and/or the new text that explicates it.

@dougwilson Thanks, that's what I was hoping, but I didn't want to assume....

@hacksparrow
Copy link
Member

👍

@crandmck
Copy link
Member Author

@crandmck
Copy link
Member Author

crandmck commented Jul 31, 2020

Closed in favor of expressjs/express#4343 and #1178

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants