How to participate in Personium document maintenance and improvement

The open source project Personium welcomes not only code but also documentation contributions. If you can help improve the documentation, please follow the steps below.

Please prepare a GitHub account

Document improvements pointed out

1. Create issue (label: bug or documentation) in GitHub repository
   1. Personium Documentation Website issues

Personium project members or other participants will then review and respond to the issue.

Adding and updating documentation

1. Fork the following GitHub repository
   1. Personium Documentation Website
2. Clone to your local environment
3. Read the README before you starts working on the bug fix and/or improvement.
4. Push to your forked GitHub repository and send a Pull Request to the original repository

Personium project members will review, merge and publish it accordingly. We look forward to your cooperation.

---

Note of the Document description

• Line break in sentences If you wish to line break in sentences, do not use <br>, enter two space characters and enter a new line. However, please use <br> if you want line break in the table. For example)
  abcdefg (two space characters)
  hijklmn

• How to disable the automatic conversion of URL to hyperlink during the MD to HTML conversion
  If you make an entry like "http://~" in the MD file, it will be automatically converted to a hyperlink. If you do not want to have a hyperlink in the description. You have to explicitly write ":" instead of ":". For example) http://

• How to write of the cURL command sample
  If the cURL command sample is longer than 100 characters, please make a line feed so that the length per line is less than 100 characters. For example) curl "https://{UnitFQDN}/__ctl/Cell" -X POST -i -H 'Authorization: Bearer {AccessToken}' \(Append \ to the line break position) -H 'Accept: application/json' -d '{"Name":"{CellName}"}'