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

Context Part does not explain use of schemas, schemas are missing key documentation #1032

Closed
kriswest opened this issue Jul 20, 2023 · 0 comments · Fixed by #1020
Closed
Labels
Context Data & Intents Contexts & Intents Discussion Group context-data FDC3 Context Data Working Group docs Documentation project governance

Comments

@kriswest
Copy link
Contributor

The Context Part of the FDC3 Standard makes use of JSON Schema definitions as the 'source of truth' for context definitions (supported by docs and examples on the reference pages). However, this is not explained anywhere in the Standard's documentation.

FDC3's use of schemas should be improved by:

  • Adding detail to the Context overview on:
    • How JSON schemas are used
    • What to include in a schema
  • Copying documentation from markdown pages into JSON Schemas

Making these changes would enable future changes to generate the docs pages from the schema files (reducing maintenance / making future contributions easier)

Area of Issue

[x] Context Data

@kriswest kriswest added docs Documentation context-data FDC3 Context Data Working Group project governance Context Data & Intents Contexts & Intents Discussion Group labels Jul 20, 2023
@kriswest kriswest added this to the 2.1-release-tasks milestone Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Context Data & Intents Contexts & Intents Discussion Group context-data FDC3 Context Data Working Group docs Documentation project governance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant