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

Copying markdown docs for contexts into schema files #1020

Merged
merged 18 commits into from
Sep 11, 2023

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented Jul 5, 2023

Pr that migrates context docs from markdown files into a schema. The markdown files still exists for the time being - we hope to try an generate markdown pages or directly render documentation pages from these schemas so that we can go full circle (and then delete the hand-maintained markdown docs in favour of generated).

partially resolves #1032

@kriswest kriswest requested a review from mistryvinay July 5, 2023 15:20
@netlify
Copy link

netlify bot commented Jul 5, 2023

Deploy Preview for fdc3 canceled.

Name Link
🔨 Latest commit 78bcfa3
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/64ff19bda2a3ae0008fe2c17

@robmoffat
Copy link
Member

nice work, @kriswest

@hampshanubs
Copy link

@kriswest Great idea.

@kriswest kriswest changed the title Copying markdown docs for instrument into schema file Copying markdown docs for contexts into schema files Jul 26, 2023
@kriswest kriswest requested a review from robmoffat August 9, 2023 11:30
@kriswest kriswest requested a review from hughtroeger August 14, 2023 14:33
@kriswest
Copy link
Contributor Author

@robmoffat @mistryvinay @hughtroeger I think I'm done - all context types now have docs for all fields I believe. I've regenerated the TypeScript types, which look better now that all fields have titles - although there are still a few Purples and Fluffys - these occur because quicktype seems to treat top-level types and references differently, generating a duplicate where a context is referenced elsewhere. There may be a workaround possible by referencing all contexts in some other schema just used to do generation (meaning all are references, none are top-level). Will explore when I have time - until then, or until quicktype improves, we'll have to live with them.

These changes will need a review and merge. They should not be changing the standard, just improving the docs.

@robmoffat should be all the feed material needed to look at rendering docs from context schemas.

@kriswest kriswest marked this pull request as ready for review August 14, 2023 14:37
schemas/context/context.schema.json Outdated Show resolved Hide resolved
schemas/context/context.schema.json Outdated Show resolved Hide resolved
schemas/context/contact.schema.json Outdated Show resolved Hide resolved
schemas/context/organization.schema.json Outdated Show resolved Hide resolved
schemas/context/position.schema.json Outdated Show resolved Hide resolved
kriswest and others added 2 commits September 4, 2023 12:33
@kriswest kriswest requested review from hughtroeger and a team September 4, 2023 11:44
@kriswest
Copy link
Contributor Author

kriswest commented Sep 4, 2023

Thanks @hughtroeger, fixes applied for your review.

@mistryvinay and @finos/fdc3-maintainers I need a review from you to merge this. Most obvious change will be that there are now docs for generated typescript files that will show up in VSCode and other editors (yay) - all are drawn from the Markdown docs that we hope to replace (with rendering from schema files) in future.

@kriswest
Copy link
Contributor Author

kriswest commented Sep 5, 2023

@hughtroeger please also be aware of/review the following commit I just added to this PR which finally explains our use of JSON schema to define Context types and bridging messages:
1d29027

docs/context/ref/Action.md Show resolved Hide resolved
@kriswest kriswest requested a review from robmoffat September 6, 2023 11:08
Copy link
Contributor

@mistryvinay mistryvinay left a comment

Choose a reason for hiding this comment

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

LGTM - thanks for putting this together Kris. 🚀

@kriswest kriswest dismissed robmoffat’s stale review September 11, 2023 13:46

Missing nav entries were resolved - dismissing review so we can merge.

@kriswest kriswest merged commit a98d622 into master Sep 11, 2023
8 checks passed
@kriswest kriswest deleted the add-docs-to-context-schemas branch September 11, 2023 13:47
@bingenito bingenito mentioned this pull request Nov 6, 2023
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Context Part does not explain use of schemas, schemas are missing key documentation
5 participants