Skip to content

fix(docs): system parameters schema and cue definition #335

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

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

nathanbogale
Copy link
Contributor

Description

This PR introduces the following changes to the Brand, Campaign, Category and Decision Parameters document definition:

  1. Schema Integration:

    • Created brand, Campaign, Category specific cue files and respective json schema files with expected parameters and fields
    • Updated the payload.schema field to load and integrate the schema for Parameters from payload_schemas/(brand, campaign, category, decision)_parameters.schema.json.
  2. Metadata Enhancements:

    • Added detailed validation rules for parameters and collaborators metadata fields to ensure consistency and clarity in document references and collaboration processes.

Related Issue(s)

Parent issue: #122 (Brands, Campaigns, Categories analysis). (

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 and others added 3 commits May 15, 2025 17:46
…#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
@nathanbogale nathanbogale requested review from stevenj and neil-iohk May 19, 2025 07:05
@nathanbogale nathanbogale self-assigned this May 19, 2025
@nathanbogale nathanbogale added documentation Pull requests that update a documentation F14 labels May 19, 2025
@nathanbogale nathanbogale added the do not merge yet PR is not ready to be merged yet label May 19, 2025
@nathanbogale nathanbogale requested a review from stevenj May 22, 2025 14:36
@nathanbogale nathanbogale removed the do not merge yet PR is not ready to be merged yet label May 26, 2025
Base automatically changed from feat/signed-doc-spec-0.04 to main June 25, 2025 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update a documentation F14
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants