Skip to content
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

Import docs from the wiki into a docs/ directory. #300

Merged
merged 3 commits into from
Sep 3, 2022

Conversation

zenhack
Copy link
Contributor

@zenhack zenhack commented Sep 3, 2022

I think it will be easier to iterate/collaborate on these if we can use PRs to discuss changes. This patch:

  • pulls in everything transitively linked from the Getting Started wiki page,
  • makes all of the links relative instead of absolute, and
  • updates links in the readme to point into docs/.

@@ -38,16 +38,17 @@ Two additional steps are needed to compile `.capnp` files to Go:
GO111MODULE=off go get -u capnproto.org/go/capnp/v3/ # install go-capnproto to $GOPATH
```

To learn how to compile a simple schema, [click here](https://github.com/capnproto/go-capnproto2/wiki/Getting-Started#compiling-schema-files).
To learn how to compile a simple schema, [click here](docs/Getting-Started.md#compiling-schema-files).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lthibault, note that these section identifiers no longer exist after the changes you made; we should update those, I wanted to keep this pr smallish.

@zenhack zenhack merged commit f3fdecb into capnproto:main Sep 3, 2022
@zenhack zenhack deleted the docs-dir branch September 3, 2022 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants