LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Packages Projects Releases 32 Wiki Activity

Docs: Updated README.md files with TOC and best practices in Markdown #339

Merged
adityakaria merged 3 commits from add-table-of-contents-to-README into master 2019-10-29 21:20:06 +01:00
Conversation 1 Commits 3 Files changed 1 +57 -17
adityakaria commented 2019-10-15 20:21:10 +02:00 (Migrated from github.com)
Copy link

PR Type

What kind of change does this PR introduce?

  • Documentation changes

Motivation

Having a detailed table of contents eases the pain of having to search for information in the given file, and gives the user some helpful jump-links to different parts of the documentation.

Other changes

  • Added and Removed whitespaces/blank-lines wherever necessary
  • Removed trailing colon mark in headings to comply with best markdown practices

PR Checklist

  • I have checked that this PR does not introduce a breaking change
## PR Type What kind of change does this PR introduce? - [x] Documentation changes ## Motivation Having a _detailed_ table of contents eases the pain of having to search for information in the given file, and gives the user some helpful jump-links to different parts of the documentation. ## Other changes - Added and Removed whitespaces/blank-lines wherever necessary - Removed trailing colon mark in headings to comply with best markdown practices ## PR Checklist - [x] I have checked that this PR does not introduce a breaking change
adityakaria commented 2019-10-15 20:39:19 +02:00 (Migrated from github.com)
Copy link

I notice that TOC has been in other PR's as well, one being for the same file. Just wanted to mark a point of difference that I have added a more detailed TOC.

Apart from that, I have made a couple of other changes that are unique to this PR (as mentioned in the PR description). This is my first contribution to this repository, so any suggestions would be most appreciated. Thanks!

I notice that TOC has been in other PR's as well, one being for the same file. Just wanted to mark a point of difference that I have added a more detailed TOC. Apart from that, I have made a couple of other changes that are unique to this PR (as mentioned in the PR description). This is my first contribution to this repository, so any suggestions would be most appreciated. Thanks!
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
area: devops

   
area: discovery

   
area: docs

   
area: livestream

   
area: proposal

Work is part of a proposal

  
consider soon

Discuss this issue at the next planning meeting, then remove this label

  
Epic

   
good first issue

   
hacktoberfest

Welcome to Hacktoberfest

  
hard fork

   
help wanted

   
icebox

Long-term storage

  
Invalid

   
level: 0

   
level: 1

No knowledge of the existing code required

  
level: 2

Some knowledge of the existing code is recommended

  
level: 3

Significant knowledge of the existing code is recommended

  
level: 4

Intimate knowledge of the existing code is recommended

  
needs: exploration

Solution unclear, needs research

  
needs: grooming

Issue needs to be groomed before work can start

  
needs: priority

Priority level needs to be defined

  
needs: repro

Issue needs step-by-step instructions on how to reproduce in latest code

  
needs: tech design

Needs technical design signoff before implementation can begin

  
on hold

Temporarily paused

  
priority: blocker

Issue is blocking release, do ASAP

  
priority: high

Work needs to be moved into sprint ASAP

  
priority: low

Work should be done but can stay in the backlog for now

  
priority: medium

Work needs to be done within 2-3 sprints

  
resilience

   
soft fork

   
Tom's Wishlist

   
type: bug

Existing functionality is wrong or broken

  
type: discussion

A conversation. No specific changes requested

  
type: improvement

Existing (or partially existing) functionality needs to be changed

  
type: new feature

New functionality that does not exist yet

  
type: refactor

Minimal user-visible changes, but significant internal work

  
type: task

Either work that's not related to the code, or a small chore that does not fit into other categories

  
type: testing

Solution needs additional user testing

  
unplanned

Work that was not planned into the spirnt, took priority over planned work

  
work in progress

The proposed solution is still incomplete.

No labels
area: devops
area: discovery
area: docs
area: livestream
area: proposal
consider soon
Epic
good first issue
hacktoberfest
hard fork
help wanted
icebox
Invalid
level: 0
level: 1
level: 2
level: 3
level: 4
needs: exploration
needs: grooming
needs: priority
needs: repro
needs: tech design
on hold
priority: blocker
priority: high
priority: low
priority: medium
resilience
soft fork
Tom's Wishlist
type: bug
type: discussion
type: improvement
type: new feature
type: refactor
type: task
type: testing
unplanned
work in progress
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: LBRYCommunity/lbrycrd#339
No description provided.
Delete branch "add-table-of-contents-to-README"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?