]> Cypherpunks repositories - gostls13.git/commitdiff
doc/README: clarify instructions
authorAlan Donovan <adonovan@google.com>
Fri, 26 Jan 2024 16:19:22 +0000 (11:19 -0500)
committerAlan Donovan <adonovan@google.com>
Tue, 30 Jan 2024 20:08:43 +0000 (20:08 +0000)
- State that new markdown files belong in doc/next.
- Give hints on correct markdown syntax.

For #64169

Change-Id: Ied70e7ac443530c910eea2992ca6e303bbc10499
Reviewed-on: https://go-review.googlesource.com/c/go/+/558855
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
doc/README.md

index 9f70ea952eda0534f7143f93913e6e91f1836c9f..3bb8412ad54f678c077ac5e63db347aa12cb3559 100644 (file)
@@ -13,16 +13,24 @@ corresponding to standard library package paths, and headings for those package
 paths will be generated automatically.
 
 Files in this repo's `api/next` directory must have corresponding files in
-`*stdlib/*minor`. The files should be in the subdirectory for the package with
-the new API, and should be named after the issue number of the API proposal. For
-example, an `api/next` file with the line
+`doc/next/*stdlib/*minor`.
+The files should be in the subdirectory for the package with the new
+API, and should be named after the issue number of the API proposal.
+For example, if the directory `6-stdlib/99-minor` is present,
+then an `api/next` file with the line
 
     pkg net/http, function F #12345
 
-should have a corresponding file named `net/http/12345.md`.
+should have a corresponding file named `doc/next/6-stdlib/99-minor/net/http/12345.md`.
 At a minimum, that file should contain either a full sentence or a TODO,
 ideally referring to a person with the responsibility to complete the note.
 
+Use the following forms in your markdown:
+
+       [`http.Request`](/pkg/net/http#Request)         # symbol documentation
+       [#12345](/issue/12345)                          # GitHub issues
+       [CL 6789](/cl/6789)                             # Gerrit changelists
+
 ## For the release team
 
 At the start of a release development cycle, the contents of `next` should be deleted