paullatzelsperger/docs

EDC documentation

EDC Documentation

This repository contains project-wide documentation.

• How to contribute
  • Get referenced as "friend"
  • How to create a PR
• Developer documentation
  • Coding principles
  • Styleguide
  • Handbook
  • Templates
• Project-wide decision records
• Committer guidelines
• List of adoptions

GitHub Pages

The documentation files of all EDC repositories are provided with GitHub Pages.

The pages are deployed from the /docs subdirectory to https://eclipse-edc.github.io/docs.

Local Deployment

If you want to add content or change configurations, please refer to the official Docsify documentation.

For a local deployment, install Node.js, check out this repository, and run Docsify:

$ git clone https://github.com/eclipse-edc/docs.git
$ cd docs
$ npm i docsify-cli -g
$ docsify serve docs

Contributing

See how to contribute.