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

Add quick start section to the docs readme. #2419

Merged
merged 2 commits into from
Oct 2, 2018
Merged

Conversation

ValarDragon
Copy link
Contributor


For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

docs/README.md Outdated

- [Getting started with the SDK](https://cosmos.network/docs/sdk/core/intro.html)
- [SDK Examples](/examples)
- [Join the testnet](https://cosmos.network/docs/getting-started/full-node.html#run-a-full-node)
Copy link
Contributor

Choose a reason for hiding this comment

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

you can use relative links here. see the DOCS_README for explanation

@codecov
Copy link

codecov bot commented Sep 30, 2018

Codecov Report

Merging #2419 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2419   +/-   ##
========================================
  Coverage    61.52%   61.52%           
========================================
  Files          122      122           
  Lines         7486     7486           
========================================
  Hits          4606     4606           
  Misses        2561     2561           
  Partials       319      319

Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

utACK

@cwgoes cwgoes merged commit 6cbac79 into develop Oct 2, 2018
@cwgoes cwgoes deleted the dev/add_quick_start branch October 2, 2018 12:02

- [Getting started with the SDK](./sdk/core/intro.html)
- [SDK Examples](../examples)
- [Join the testnet](./getting-started/full-node.html#run-a-full-node)
Copy link
Contributor

Choose a reason for hiding this comment

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

.md otherwise this won't work on GH

Copy link
Contributor

Choose a reason for hiding this comment

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

Change the .html endings to .md, do you mean? Won't that break on the web view?

Copy link
Contributor

Choose a reason for hiding this comment

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

no, unlike RTD, vuepress handles this

Copy link
Contributor

Choose a reason for hiding this comment

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

as proof, there's at least two "internal" links in: https://github.com/tendermint/tendermint/blob/master/docs/app-dev/getting-started.md

one uses .html and it doesn't work on GH but works on Vue
another uses .md works on both GH and Vue

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.

3 participants