Skip to content
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

feat(docs): Adds mkdocs for project documentation #332

Merged
merged 16 commits into from
Sep 6, 2021
Merged

Conversation

dutterbutter
Copy link
Contributor

@dutterbutter dutterbutter commented Sep 3, 2021

Changes

Builds off of documentation from #330

  • Adds docs dir which contains documentation sections
  • Adds docs github action workflow

TODO

  • Outline CLI commands in docs/usage/command-line.md
  • Outline configuration options in docs/usage/configuration.md
  • Add and reference contributions.md file
  • Outline steps and images for interacting with PINT using polkadot.js ui
  • Add documentation for running test suite and debugging
  • Update and add documentation for running PINT using docker

Tests

mkdocs serve

Visit http://127.0.0.1:8000/

Issues

@dutterbutter dutterbutter added the WIP Work in progress - do not review or merge label Sep 3, 2021
@CLAassistant
Copy link

CLAassistant commented Sep 3, 2021

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@Redoudou Redoudou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you guys

Copy link
Contributor

@mattsse mattsse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice,
@clearloop can you perhaps add a brief overview of:

  • what is e2e?
  • what purpose?

So that it's clear that this is intended for cross chain testing

@clearloop
Copy link
Contributor

clearloop commented Sep 6, 2021

Should we add a chapter of debugging and introduce root call? most of the calls of PINT can not run independent before adding asset ( or creating a feed first )

@mattsse
Copy link
Contributor

mattsse commented Sep 6, 2021

Should we add a chapter of debugging and introduce root call? most of the calls of PINT can not run independent before adding asset ( or creating a feed first )

I'll describe these in a dedicated section that describeds the asset-index logic

Copy link
Contributor

@mattsse mattsse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@dutterbutter dutterbutter marked this pull request as ready for review September 6, 2021 14:41
@dutterbutter dutterbutter merged commit ed892ea into main Sep 6, 2021
@dutterbutter dutterbutter deleted the db/docs branch September 6, 2021 14:41
mattsse added a commit that referenced this pull request Sep 6, 2021
* feat: added docs

* wip: pint documentation

* Update index.md

* Update index.md

* docs: update docs

* docs: add resources readme

* fix: typos

* docs: add note about parachain

* docs: add standalone chain docs

* docs: update run commands

* docs: add note

* feat(docs): adds docker option in getting-started

* feat(docs): adds test chapter in installation

* feat(docs): adds summary of e2e testing

* feat(docs): note git submodule in e2e tests

* feat(docs): fix typo in the submmary of e2e tests

Co-authored-by: Redwan <[email protected]>
Co-authored-by: Matthias Seitz <[email protected]>
Co-authored-by: clearloop <[email protected]>
clearloop added a commit that referenced this pull request Sep 7, 2021
* feat: make --dev work standalone

* feat: set address

* fix: prefund root account

* feat: add index token deposit range (#336)

* feat: add deposit range

* feat: remove dot contribution limits

* feat(docs): Adds mkdocs for project documentation  (#332)

* feat: added docs

* wip: pint documentation

* Update index.md

* Update index.md

* docs: update docs

* docs: add resources readme

* fix: typos

* docs: add note about parachain

* docs: add standalone chain docs

* docs: update run commands

* docs: add note

* feat(docs): adds docker option in getting-started

* feat(docs): adds test chapter in installation

* feat(docs): adds summary of e2e testing

* feat(docs): note git submodule in e2e tests

* feat(docs): fix typo in the submmary of e2e tests

Co-authored-by: Redwan <[email protected]>
Co-authored-by: Matthias Seitz <[email protected]>
Co-authored-by: clearloop <[email protected]>

* feat(js): adds scripts in js directory (#339)

* feat(js): adds scripts updating types.json in js

* feat(js): export e2e script to workspace

* chore(docs): add more chain spec info (#341)

* chore: upgrade chainlink pallet (#340)

* chore: upgrade chainlink pallet

* fix: use latest genesis config

* chore(docs): update readme

* fix: dev command argument

Co-authored-by: Dustin Brickwood <[email protected]>
Co-authored-by: Redwan <[email protected]>
Co-authored-by: clearloop <[email protected]>
Co-authored-by: clearloop <[email protected]>
@mattsse mattsse mentioned this pull request Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP Work in progress - do not review or merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants