feat(docs): Add payload examples #342
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevenj
added
review me
nathanbogale
approved these changes
May 20, 2025
|
✅ Test Report | |
stevenj
added a commit
that referenced
this pull request
Jun 25, 2025
* fix(docs): correct python type annotations in documentation generator (#325) * feat(docs): Consolidate all parameters types into a single parameters reference. * fix(docs): Fix linked references * feat(docs): Start of adding capability to cluster like documents to simplify relationship diagrams. * fix(docs): wip fix of clustered documents * feat(docs): Add document clusters to help with autogenerated diagrams. * fix(docs): fix spelling * fix(Python): fix type * fix(docs): Inter doc links in diagrams * fix(docs): Neils Eyesight Soother * fix(docs): Rename Election Parameters to Decision parameters * fix(docs): python types * fix(docs): add missing doc generator type definitions * fix(general): Updater recommended vscode settings * docs(docs): Better define the document encoding restrictions. (#326) * feat(docs): Add examples for predefined document schemas (#342) * format the blueprint.cue * fix(docs): Update module to latest cue version * feat(docs): WIP formalized definitions of field definitions for json schema templates * feat(docs): WIP * fix(docs): simplify schema with cue format * feat(docs): WIP template defs dictionary * fix(docs): update python files we don't want in git * refactor(docs): reorganize the cue files for better modularity * refactor(docs): Move spec python model for better modularity * docs(docs): Add base of new spec python workspace and modules * fix(docs): remove lin to root ruff.toml which was impacting import sorting * refactor(docs): Reorganize the doc generator into the new module structure * refactor(docs): Cleanup document specification data structure and methods * refactor(docs): Remove last remnants of direct dict accesses. * refactor(docs): remove code obsoleted by refactor * refactor(docs): large cue refactor to stuff that should be common * docs(docs): Add chain metadata to support chained document references. * fix(docs): lint issues * fix(docs): lint issues * fix(docs): CI build issues * docs(docs): wip * docs(docs): Add fully generalized, templated parameters documents to the specification. * fix(docs): form templates do not have templates * fix(docs): remove the parameters from templates on the parameters documents themselves (redundant). * fix(docs): use common parameters definition * feat(docs): Add Representative Profiles and Nomination Forms * feat(docs): Add Rep Profiles, Nominations and Delegations documents * Update contest_delegation.cue Break line with multiple sentences * fix excess lines in null payload description * fix(docs): contest delegation spacing * fix(docs): contest structure fix * fix(docs): structure quick fix * fix(docs): fixed indentation in contest md * fix(docs): contest cue file fix * fix(docs): quick fix on indentation * fix(docs): markdown indentation fix * fix(docs): minor character and structure fix * fix(docs): contest cue file fix * fix(docs): additional indentation fix --------- Co-authored-by: Nathan Bogale <nathanbogale@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds examples for predefined document schemas.
Updates proposal submission action to have such examples defined.
Related Issue(s)
List the issue numbers related to this pull request.
Description of Changes
Provide a clear and concise description of what the pull request changes.
Breaking Changes
Describe any breaking changes and the impact.
Screenshots
If applicable, add screenshots to help explain your changes.
Related Pull Requests
If applicable, list any related pull requests.
Please confirm the following checks