From a188679b987d34d56547aa5aa624bd56ec3ff80b Mon Sep 17 00:00:00 2001 From: Pranav Konde <76070589+pranavkonde@users.noreply.github.com> Date: Mon, 27 Jan 2025 16:44:26 +0530 Subject: [PATCH 1/2] Update README.md fix typos --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5a62a4a..2d9c83d 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,11 @@ Built on next, the pages live in `src/app`. See https://nextjs.org/docs/app Add pages as markdown with .md extension to `src/pages` -The path to the file is used as the url, e.g. `src/pages/w3cli.mdx` -> `/w3cli`. +The path to the file is used as the URL, e.g. `src/pages/w3cli.mdx` -> `/w3cli`. -The `_meta.json` in the directory defines the order of links in the sidebar and the values set their link text. +The `_meta.json` in the directory defines the order of links in the sidebar and the values set for their link text. -Update the `_meta.json` file in the directory when you add a new page. There should be one in each sub directory. +Update the `_meta.json` file in the directory when you add a new page. There should be one in each sub-directory. `src/pages/_meta.json` @@ -53,13 +53,13 @@ Update the `_meta.json` file in the directory when you add a new page. There sho In the above: - `"pail"` is a hidden section, allowing us to add docs that we don't want to publish yet. -- `"specs"` ads a sidebar link to the github repo, there is no associated markdown file here. +- `"specs"` add a sidebar link to the github repo, there is no associated markdown file here. Docs section is built on nextra. See https://nextra.site/docs/guide/organize-files for more. ### Links -To link to other pages using the root relative url in a standard markdown link. To link to the w3cli.md from the quickstart page, your would include: +To link to other pages using the root relative URL in a standard markdown link. To link to the w3cli.md from the quickstart page, you would include: **quickstart.md** ```md From 84a4096fbcd04546a03a3ad99fd1859d1c53ac4f Mon Sep 17 00:00:00 2001 From: Pranav Konde <76070589+pranavkonde@users.noreply.github.com> Date: Tue, 1 Apr 2025 16:38:22 +0530 Subject: [PATCH 2/2] Update README.md Made the Suggested Changes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d9c83d..232b417 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Add pages as markdown with .md extension to `src/pages` The path to the file is used as the URL, e.g. `src/pages/w3cli.mdx` -> `/w3cli`. -The `_meta.json` in the directory defines the order of links in the sidebar and the values set for their link text. +The `_meta.json` in the directory defines the order of links in the sidebar and the values set their link text. Update the `_meta.json` file in the directory when you add a new page. There should be one in each sub-directory. @@ -53,7 +53,7 @@ Update the `_meta.json` file in the directory when you add a new page. There sho In the above: - `"pail"` is a hidden section, allowing us to add docs that we don't want to publish yet. -- `"specs"` add a sidebar link to the github repo, there is no associated markdown file here. +- `"specs"` adds a sidebar link to the github repo, there is no associated markdown file here. Docs section is built on nextra. See https://nextra.site/docs/guide/organize-files for more.