How To Edit developer.holochain.org Pages

Documentation for the website is written in Markdown, and converted into HTML automatically. This means we can edit the documentation files in Markdown on Github, which has a good interface for editing it.

  1. go to the url for the folder that contains the "Resources" documentation files (on the branch documentation-drive) and click on the one you're looking for, such as first-happ.md: https://github.com/holochain/docs-pages/blob/documentation-drive/src/resources/
  2. click the 'edit pencil' to launch into 'edit mode'

    you will see
  3. make some edits to the documentation
  4. preview your edits by clicking the 'eyeball'/preview icon, to make sure that you've written good valid markdown that looks right rendered as HTML
  5. scroll to the bottom and add a short, and maybe longer description of your changes, and then hit 'Propose Changes'
  6. Click the big green 'Create Pull Request' button
  7. Give your pull request a name, and description (could reuse the text from before) and click the big green 'Create Pull Request' button
  8. wait for someone (likely Otter) to review your pull request so you can make edits or improvements, if it's been "Approved" your pull request will get "Merged" with no further conversation. You will be notified by email and in Github if they review your Pull Request.
  9. If someone makes comments on your pull request, you can make another edit on your files by going to 'Files Changed' tab and clicking '...' (ellipsis) -> Edit File
  10. Again, when the pull request gets marked as "Approved" it will be merged!
  11. Check out your new edits on the live test site: https://deploy-preview-289fervent-tesla-2a3da2.netlify.app/
Select a repo