README rework - Githubissues

scaleway / serverless-scaleway-functions

Plugin for Serverless Framework to allow users to deploy their serverless applications on Scaleway Functions

MIT License

78 stars 25 forks source link

README rework #166

Closed Shillaker closed 1 year ago

Shillaker commented 1 year ago

Note, this PR is best reviewed by looking at the final version of the docs on the branch.

What's changed?

Move all non-essential docs to docs folder
Show examples of both function and container configuration in README
Show configuration in configuration file format, not bullet points in text
Remove docs/README.md
Fixed version of prettier used in Linting (3.0.0 is latest and finds issues all over codebase)

Why is this necessary?

README was long, verbose and inaccurate in parts
README made it difficult to differentiate between function and container config options
Putting the config file in text bullet points was hard to translate to YAML. Easier to copy-paste from a YAML format
docs/README.md was almost all duplicated information
A single large markdown file is difficult to browse from a terminal, separate files in a docs folder are easier

asuri0n commented 1 year ago

good updates :+1: