Skip to content

docs(docs): Better define the document encoding restrictions. #326

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 16, 2025
Merged

docs(docs): Better define the document encoding restrictions. #326

merged 1 commit into from
May 16, 2025

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented May 15, 2025

Description

Clarifies the restrictions in place on validly encoded Catalyst Signed Documents, above and beyond what is defined by COSE Sign.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj requested review from nathanbogale and neil-iohk May 15, 2025 14:55
@stevenj stevenj self-assigned this May 15, 2025
@stevenj stevenj added documentation Pull requests that update a documentation review me PR is ready for review labels May 15, 2025
@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 319/319}$ | ${\color{red}Fail: 0/319}$ |

dt-iohk
dt-iohk reviewed May 16, 2025
View reviewed changes
Copy link

@dt-iohk dt-iohk left a comment

Choose a reason for hiding this comment

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

Looks good for the frontend!

@stevenj stevenj merged commit 3ffc8e5 into feat/signed-doc-spec-0.04 May 16, 2025
24 checks passed
@stevenj stevenj deleted the feat/improve-doc-encoding-specifications branch May 16, 2025 09:15
stevenj added a commit that referenced this pull request Jun 25, 2025
@stevenj @nathanbogale
feat(docs): signed doc spec 0.04 (#341)
595cfea 
* 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dt-iohk dt-iohk dt-iohk left review comments

@neil-iohk neil-iohk neil-iohk approved these changes

@nathanbogale nathanbogale Awaiting requested review from nathanbogale

Assignees

@stevenj stevenj

Labels
documentation Pull requests that update a documentation review me PR is ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stevenj @dt-iohk @neil-iohk