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

docs: add docs on modules (backport #2269) #2322

Merged
merged 2 commits into from
Oct 2, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 2, 2024

Description

Closes: #XXXX

ToDo:

  • update previous pages to be consistent with the changes introduced by permissionless @insumity
  • add state for consumer module in docs/docs/build/modules/03-consumer.md
  • add info on client (CLI, REST, gRPC) for both consumer and provider module @sainoe

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

This is an automatic backport of pull request #2269 done by [Mergify](https://mergify.com).

* add docs/build folder

* add module structure

* add provider messages to docs -- wip

* add message description to docs

* add provider params

* add consumer params

* remove params.md

* fix links

* add overview

* add IBC channel handshake

* add OnRecvPacket

* move democracy module to build/modules

* remove duplicate democracy module page

* add begin/end-block info

* udpate intro section

* add info on provider state

* add consumer state

* add state intro

* add TODOs

* add CLI

* WIP - add provider CLI, gRPC, REST docs

* fix typos

* add consumer docs wip

* provider docs nits

* consumer docs nits

* consumer docs improvement

* merge main

* add collapsible sections

* update overview

* docs: fix broken docs; cleanup versions (#2321)

* docs: update config and supported verisons

* fix broken config

* fix broken version import

* add back missing image

* expand toc level

* fix broken link

---------

Co-authored-by: Simon Noetzlin <[email protected]>
Co-authored-by: MSalopek <[email protected]>
(cherry picked from commit d0a1398)

# Conflicts:
#	docs/docs/introduction/params.md
@mergify mergify bot requested a review from a team as a code owner October 2, 2024 11:53
@mergify mergify bot added the conflicts label Oct 2, 2024
@mergify mergify bot assigned mpoke Oct 2, 2024
Copy link
Contributor Author

mergify bot commented Oct 2, 2024

Cherry-pick of d0a1398 has failed:

On branch mergify/bp/release/v6.1.x/pr-2269
Your branch is up to date with 'origin/release/v6.1.x'.

You are currently cherry-picking commit d0a1398e.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   .gitignore
	modified:   docs/build_deploy.sh
	new file:   docs/docs/build/_category_.json
	new file:   docs/docs/build/modules/01-overview.md
	new file:   docs/docs/build/modules/02-provider.md
	new file:   docs/docs/build/modules/03-consumer.md
	renamed:    docs/docs/features/democracy-modules.md -> docs/docs/build/modules/04-democracy.md
	new file:   docs/docs/build/modules/_category_.json
	modified:   docs/docs/consumer-development/consumer-genesis-transformation.md
	modified:   docs/docs/features/_category_.json
	modified:   docs/docs/features/reward-distribution.md
	modified:   docs/docs/frequently-asked-questions.md
	modified:   docs/docs/index.mdx
	modified:   docs/docs/integrators/_category_.json
	modified:   docs/docs/introduction/_category_.json
	modified:   docs/docs/introduction/overview.md
	modified:   docs/docs/introduction/terminology.md
	modified:   docs/docs/validators/_category_.json
	modified:   docs/docusaurus.config.js
	modified:   docs/supported_versions.json
	modified:   tests/e2e/test_runner.go
	modified:   x/ccv/consumer/keeper/keeper.go
	modified:   x/ccv/consumer/types/keys.go
	modified:   x/ccv/provider/keeper/permissionless.go

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by them: docs/docs/introduction/params.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@github-actions github-actions bot added C:Testing Assigned automatically by the PR labeler C:x/consumer Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler C:Docs Assigned automatically by the PR labeler labels Oct 2, 2024
@mpoke mpoke merged commit 22fef42 into release/v6.1.x Oct 2, 2024
8 of 9 checks passed
@mpoke mpoke deleted the mergify/bp/release/v6.1.x/pr-2269 branch October 2, 2024 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Docs Assigned automatically by the PR labeler C:Testing Assigned automatically by the PR labeler C:x/consumer Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler conflicts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant