Skip to content

Conversation

@stevenj
Copy link
Collaborator

@stevenj stevenj commented Jul 9, 2025

Description

This specification update Includes:

  • Fixed typographical and layout issues.
  • Added specifications for Form Templates and Elements.
  • Reverted Document Types to a Single UUID from an Array of UUIDs
  • Changed versions to be semantic (0.04 became 0.0.4)
  • Corrected Parameter References for Brand/Campaign/Category/Contest Templates
  • Replaced poorly formatting markdown tables with HTML equivalents.
  • Added draft placeholders for Moderation Documents (subject to change)
  • Clarified How Representatives may delegate.
  • Clarified what happens when a new version of a Nomination Document is published.
  • Clarified how delegations can be revoked.
  • Clarified the payload for delegations.
  • Generalized Presentation Templates, and defined sample (subject to change) cards.
  • Removed specialized presentation templates, as a universal presentation template is all thats required.
  • Converted draft-7 Json Schemas to 2020-12
  • Add standard ICON definitions for Forms.

Rendered Spec

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 added documentation Pull requests that update a documentation enhancement New feature or request wip draft Draft p: normal The issue or pull request is of normal priority and can be addressed in due course rr: architecture Required review - Architecture team must approve before merge labels Jul 9, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jul 9, 2025

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

@stevenj stevenj changed the title feat(docs): Specification Update 0.10 feat(docs): Specification Update 0.1.0 Jul 22, 2025
stevenj and others added 10 commits July 22, 2025 07:23
* feat(docs): Autogenerate the element dictionary and ref the element docs * fix(docs): spec.md headers formatting * fix(docs): dont use inline html * fix(docs): CI * fix(docs): spelling * fix(docs): Generate spec.md from its template * feat(docs): add capability to link to a heading in a doc * fix(docs): remove experimental mdformat code (not formatted how we need, and not configurable.) * feat(docs): Generate .pages from template * fix(docs): don't need filename with template of same name * feat(docs): Generate types.md from template * feat(docs): Generate the metadata.md file from a template * feat(docs): Generate docs for each of the doc pages using templates * feat(docs): generalize inter page link generation * feat(docs): First genersation of form element documentation * feat(docs): wip for element parameters docs * feat(docs): Control icon assets with the specifications * fix(docs): cleanup how we document available icons * docs(docs): element parameters updates WIP * feat(docs): Autogenerates the example schema for form elements correctly * fix(docs): re-order the form template specs to match the schema * feat(docs): Add examples and better docs for Multiline text entry * feat(docs): fully document all elements except the tag selector * feat(docs): Revert document type to a single UUIDv4 * docs(docs): Mark proposal moderation actions as speculative * fix(docs): Cleanup drep nomination/delegation descriptions around revocation. * feat(docs): make doc generation heirarchial and cleanup status display * feat(docs): add regex for form names and title case names * feat(docs): Create a module that holds all the doc types for easier re-use between modules * feat(docs): Change the signed docs defs to use the doct type module * fix(docs): format * feat(docs): first version of the presentation template specs - data only * feat(docs): draft business logic pages - not rendered * feat(docs): add initial red delegation flows * feat(docs): presentation templates wip * feat(docs): draft version of the presentation template docs * fix(docs): markdown lint issues
@stevenj stevenj merged commit 513b090 into main Jul 31, 2025
24 checks passed
@stevenj stevenj deleted the feat/spec-0.10 branch July 31, 2025 05:11
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 draft Draft enhancement New feature or request p: normal The issue or pull request is of normal priority and can be addressed in due course rr: architecture Required review - Architecture team must approve before merge wip

4 participants