diff --git a/site/content/docs/Contribution guidelines/_index.md b/site/content/docs/Contribution guidelines/_index.md index fcfb37825..85dbe80aa 100644 --- a/site/content/docs/Contribution guidelines/_index.md +++ b/site/content/docs/Contribution guidelines/_index.md @@ -6,9 +6,10 @@ toc_hide: true > NOTE: Those guidelines are preliminary and will change as the project grows and expands in scope. -## Contacting Developers +## Code Documentation -* Using [Slack](https://slack.kopia.io) is the quickest way to get in touch with developers. +Kopia is primarily written using [The Go Programming Language](https://go.dev/doc/). +The source code documentation can be found on [godoc.org](https://godoc.org/github.com/kopia/kopia/repo). ## Submitting issues @@ -35,3 +36,7 @@ toc_hide: true - `` is a clear description of a PR. - Follow the pattern precisely, as the title-checker cares about capitalization parentheses, and spaces. - For example: `feat(cli): Add new policy rule --new-feature-x to enable using feature x`. + +## Contacting Community + +* Use [Slack](https://slack.kopia.io) to reach out to other developers. diff --git a/site/content/docs/Reference/Command-Line/_index.md b/site/content/docs/Reference/Command-Line/_index.md index 6ff03bec3..36fb26f81 100644 --- a/site/content/docs/Reference/Command-Line/_index.md +++ b/site/content/docs/Reference/Command-Line/_index.md @@ -1,6 +1,6 @@ --- -title: "Command Line" -linkTitle: "Command Line" +title: "Command-Line Reference" +linkTitle: "Command-Line Reference" weight: 10 --- diff --git a/site/content/docs/Reference/Go API/_index.md b/site/content/docs/Reference/Go API/_index.md deleted file mode 100644 index fa15a6a4b..000000000 --- a/site/content/docs/Reference/Go API/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Go API" -linkTitle: "Go API" -weight: 1 ---- - -Kopia provides programmatic API for accessing the repository. - -The documentation can be found on [godoc.org](https://godoc.org/github.com/kopia/kopia/repo). diff --git a/site/content/docs/Reference/_index.md b/site/content/docs/Reference/_index.md index 4f66f11a1..0fc5359ff 100644 --- a/site/content/docs/Reference/_index.md +++ b/site/content/docs/Reference/_index.md @@ -1,10 +1,9 @@ --- -title: "Command-Line References" -linkTitle: "Command-Line References" +title: "Reference" +linkTitle: "Reference" weight: 40 hide_summary: true no_list: true --- -* [Go API Reference](go-api/) * [Command-Line Reference](command-line/) diff --git a/tools/cli2md/cli2md.go b/tools/cli2md/cli2md.go index 1f80444d6..a6e63c340 100644 --- a/tools/cli2md/cli2md.go +++ b/tools/cli2md/cli2md.go @@ -311,8 +311,8 @@ func generateSubcommandPage(fname string, cmd *kingpin.CmdModel) { } } - fmt.Fprintf(f, "```shell\n$ kopia %v%v%v\n```\n\n", cmd.FullCommand, flagSummary, argSummary) //nolint:errcheck - fmt.Fprintf(f, "%v\n\n", escapeFlags(cmd.Help)) //nolint:errcheck + fmt.Fprintf(f, "```shell\n$ kopia %v%v%v\n```\n\n", cmd.FullCommand, flagSummary.String(), argSummary.String()) //nolint:errcheck + fmt.Fprintf(f, "%v\n\n", escapeFlags(cmd.Help)) //nolint:errcheck emitFlags(f, cmd.Flags) emitArgs(f, cmd.Args)