-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Comments
How about a new menu titled "Examples"? |
The menu items would be links to the respective example directories. |
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. |
Also, have all these examples been updated for 5.x? @dougwilson |
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). |
Maybe a link titled "Examples" under "Resources"? This page would list the links to the examples with a brief description of each example. |
@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.... |
👍 |
Started some notes: https://github.com/strongloop/expressjs.com/wiki/Example-notes. |
Closed in favor of expressjs/express#4343 and #1178 |
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.
The text was updated successfully, but these errors were encountered: