-
Notifications
You must be signed in to change notification settings - Fork 132
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
Conversation
✅ Deploy Preview for fdc3 canceled.
|
nice work, @kriswest |
@kriswest Great idea. |
370565f
to
09279da
Compare
…e versions of the context ype to avoid importing its docs onto all other types.
@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. |
Improving FDCS_ID description in instrument
Co-authored-by: Hugh Troeger <htroeger@factset.com>
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. |
@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: |
There was a problem hiding this 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. 🚀
Missing nav entries were resolved - dismissing review so we can merge.
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