State of documentation

[ralphtheninja]

The state of README.md (style updated with level badge etc), CHANGELOG.md and UPGRADING.md.

EDIT (@ralphtheninja): Updated with LICENSE.md/CONTRIBUTORS.md/README.md which essentially means "There is a LICENSE.md file and a CONTRIBUTORS.md file, where LICENSE.md links to CONTRIBUTORS.md and README.md links to LICENSE.md according to new and simplified format in https://github.com/Level/level-js/tree/ce8d77c89f38e444b6951e890aa3b5e72a221aaf#license"

EDIT (@vweevers): Added tasks to remove contributors from package.json and to remove copyright headers from code.

Below is a summary of all repositories. Some of these are not actively maintained and some might be more or less irrelevant for other reasons, e.g. maybe we don't need UPGRADING.md for electron-demo etc.

Please comment and/or edit this post if you think that something should be archived or need special care.

• abstract-leveldown
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• awesome
  • README.md (needs to be re-generated after level-js and level-browserify)
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• codec
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• concat-iterator
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• community
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• deferred-leveldown
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• electron-demo
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• encoding-down
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• errors
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• iterator-stream
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• leveldb.org
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• leveldown
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• leveldown-hyper
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-hyper
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-js
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-test
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-rocksdb
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-ttl
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• levelup
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-ws
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• mem
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• memdown
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• packager
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• rocksdb
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• subleveldown
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• lazy-open (archived)
  • README.md
  • CHANGELOG.md
  • ~~ UPGRADING.md~~
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-lmdb (to be archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-mobile (to be archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• leveldown-mobile (to be archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-fstream (to be archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-basho (archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• level-browserify (archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• typings (archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code
• database (archived)
  • README.md
  • CHANGELOG.md
  • UPGRADING.md
  • LICENSE.md/CONTRIBUTORS.md/README.md
  • Remove contributors from package.json
  • Remove copyright headers from code

[vweevers]

+1 to archiving not actively maintained repos

[vweevers]

Except for typings, as I understand it that's a temporary home for typescript, and a work-in-progress.

[ralphtheninja]

I think we should at least tweak the README of not actively maintained before archiving, it's quickly done.

[ralphtheninja]

Lets make another pass at this later with LICENSE.md (which should link to ->) and CONTRIBUTORS.md. Also, README should end with the cleaner ## License header.

[ralphtheninja]

Updated.

[vweevers]

@ralphtheninja as part of this effort, should we also:

1. Remove contributors from package.json
2. Remove copyright headers from JS files

I think yes. See Level/levelup#587 (comment).

[ralphtheninja]

@ralphtheninja as part of this effort, should we also:

Remove contributors from package.json
Remove copyright headers from JS files

I think yes. See Level/levelup#587 (comment).

Agreed.

[vweevers]

Added.

[ralphtheninja]

Funny enough, leveldown-hyper is the first project to tick all boxes 😄

[ralphtheninja]

I ticked the boxes for irrelevant tasks, just to see the progress and what's really left to do.

[ralphtheninja]

I archived the database repository.

[ralphtheninja]

@vweevers I'm going to refer to LICENSE.md/CONTRIBUTORS.md/README.md as hallmark from now on, so if you see issues created mentioning hallmark, this is what I mean.

[vweevers]

Ticked typings.