Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Arrange the docs by filename and merge few files together #305

Merged
merged 3 commits into from Dec 2, 2020
Merged

Arrange the docs by filename and merge few files together #305

merged 3 commits into from Dec 2, 2020

Conversation

hhio618
Copy link
Contributor

@hhio618 hhio618 commented Dec 2, 2020

Description

Arrange documents in the docs folder.

Refs

#268

@coveralls
Copy link

coveralls commented Dec 2, 2020 •
edited

Pull Request Test Coverage Report for Build 396925655

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 36.271%
Totals Coverage Status
Change from base Build 394506693: 0.0%
Covered Lines: 1523
Relevant Lines: 4199
💛 - Coveralls

krasi-georgiev
krasi-georgiev reviewed Dec 2, 2020
View reviewed changes
docs/04_contributing.md Outdated
@@ -59,7 +59,7 @@ $ <Iterate your development>
$ git push fork <your_PR_branch>
```

1. If your change affects users (adds,removes or changes a feature) add the item to the [CHANGELOG](CHANGELOG.md).
1. If your change affects users (adds,removes or changes a feature) add the item to the [CHANGELOG](08_CHANGELOG.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hm, I think we should keep the CHANGELOG filename unchanged. Ideally we want it last in the docs list, but it is ok even if shows at the begining.

@krasi-georgiev
Copy link
Collaborator

Since we are arranging the docs already, can you do these changes as well:

  • merge pages: reference + configuration
  • put the text from Disclaimer into Become a miner
  • in README - change the formating of the block DISCLAIMER so that it doesn't have a vertical scrolling.
  • rename The Guide -> Setup and usage
  • Merge Become a Minero into Setup and usage.

@krasi-georgiev krasi-georgiev changed the title Arrange docs Arrange the docs by filename and merge few files together Dec 2, 2020
@krasi-georgiev krasi-georgiev merged commit 3e2af55 into tellor-io:master Dec 2, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@krasi-georgiev krasi-georgiev krasi-georgiev left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@hhio618 @coveralls @krasi-georgiev