Update Basic Routing page with clearer explanations and examples #1485
Conversation
This commit aims to enhance the readability and usefulness of the Basic Routing page for developers learning to use Express.
There was a problem hiding this comment.
Please make sure you follow the Doc style guide.
I started to review and left a few comments, but please review your PR for adherence to the style guide.
And I prefer to err on the side of brevity. Avoid the breezy stuff, as this is not a blog post.
As it stands, this PR doesn't add much value.
| @@ -1,68 +1,73 @@ | |||
| --- | |||
| layout: page | |||
| title: Express basic routing | |||
| title: Building a Node.js Express Server: Basic Routing | |||
There was a problem hiding this comment.
To use a colon character in the title, you need to enclose it in quotes here. Otherwise it breaks the site build!
|
|
||
| _Routing_ refers to determining how an application responds to a client request to a particular endpoint, which is a URI (or path) and a specific HTTP request method (GET, POST, and so on). | ||
| # Basic Routing with Express: A Step-by-Step Guide |
There was a problem hiding this comment.
Don't need to say "Express," since that's a given here.
"A Step-by-Step Guide" doesn't add anything. Please omit.
|
|
||
| Each route can have one or more handler functions, which are executed when the route is matched. | ||
| Welcome to the world of building web servers with Node.js and Express! In this guide, we'll explore the fundamentals of routing in Express, which is crucial for handling client requests effectively. |
There was a problem hiding this comment.
Too jocular. This is not a blog post. Keep it simple and to the point. This whole para doesn't add anything much.
|
|
||
| Route definition takes the following structure: | ||
| Understanding Routing |
There was a problem hiding this comment.
Thankyou, I noted all the points
Yes I am used to writing blogs and storytelling.
|
Good feedback @crandmck, ty @IntegerAlex, you just got review from an expert technical writer who is attuned to creating very good documentation. We are in the proces of planning documentation updates because we have a lot of improvements we can make here, and you are clearly a passionate and talented writer who cares about Express! So let me direct your attention to our ongoing discussions at expressjs/discussions#211 We need help from people like you! We also want to make sure our writing style is cohesive and meets standards, to which @crandmck is our authority. Please don't take these comments as criticism of you, but as part of the process of achieving the best work we can do together ❤️ The risk of driveby contributions is that someone will invest time like you did, but not in the direction the project wants to go. Please work with us in the future before dedicating significant personal time to efforts which may not land. |
This commit aims to enhance the readability and usefulness of the Basic Routing page for developers learning to use Express.