README updates for the main repo, and a light overview on the docs subdir #1202
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kamebkj
reviewed
May 17, 2021
| @@ -218,4 +213,4 @@ Please respect our [Code of Conduct](.github/CODE_OF_CONDUCT.md), in short: | |||
| Evergreen is released under the MIT license. | |||
| The BlueprintJS icons are licensed under a [custom Apache 2.0 license](https://github.com/palantir/blueprint/blob/develop/LICENSE). | |||
|
|
|||
| Copyright © 2017 Segment.io, Inc. | |||
| Copyright © 2021 Segment.io, Inc. | |||
kamebkj
approved these changes
May 17, 2021
|
|
||
| When we run `next dev` the next time, Next.js will start looking for any `.ts` or `.tsx` files in our project and builds it. It even automatically creates a `tsconfig.json` file for our project with the recommended settings. | ||
| From there, the directory structure in `docs/documentation/` contains the `.mdx` files which mirror the route structure for the docs site. |
There was a problem hiding this comment.
Wonder if we also want to call out adding thumbnail images and add them to public
There was a problem hiding this comment.
Done! We can always come back here and just link to the next.js documentation. We're not doing anything fancy other than using the standard filesystem setup.
|
Need to figure out why the actions keep getting cancelled, but given that this is a documentation change, it should be fine. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Updating some links now that the new evergreen.segment.com is live.
Screenshots (if applicable)
N/A
Documentation
Updated Typescript types and/or component PropTypesAdded / modified component docsAdded / modified Storybook stories