Skip to content

README rework #166

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

Merged
merged 16 commits into from
Jul 7, 2023
Merged

README rework #166

merged 16 commits into from
Jul 7, 2023

Conversation

Shillaker
Copy link
Contributor

@Shillaker Shillaker commented May 29, 2023

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

@Shillaker Shillaker self-assigned this May 29, 2023
@Shillaker Shillaker force-pushed the readme-containers-issue branch from f1eebae to 4ee57fd Compare June 16, 2023 14:44
@asuri0n
Copy link

asuri0n commented Jun 29, 2023

good updates 👍

@asuri0n asuri0n mentioned this pull request Jun 29, 2023
@Shillaker Shillaker marked this pull request as ready for review July 6, 2023 13:59
@Shillaker Shillaker requested a review from thomas-tacquet July 6, 2023 14:21
@Shillaker Shillaker requested a review from thomas-tacquet July 7, 2023 15:04
@Shillaker Shillaker merged commit b380f3b into master Jul 7, 2023
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