Create federation documentation #1720
Conversation
BentiGorlich
added
documentation
- Put some collections into the new `CollectionFactory` for easy access to the generator methods - Add some more optional `@context` - Add Markdown document for the federation documentation. This is then edited via the new `DocumentationGenerateFederationCommand` which will be called from the frontend build
BentiGorlich
force-pushed
the
new/federation-documentation
branch
from
070baae to
5272025
Compare
|
|
||
| The `@context` property for all Mbin payloads **should** be this: | ||
|
|
||
| ```json |
There was a problem hiding this comment.
Are you sure this will work with our online deployment towards joinmbin.org docs site?
Is this additional command automatically called during the doc building?
There was a problem hiding this comment.
Ow.. You added this as a separate build step?.. Mhh I see MbinOrg/mbin-docs#12
There was a problem hiding this comment.
I wish there was a better way.
There was a problem hiding this comment.
Well yes it is not optimal. However it is better than doing it manually in my opinion...
There was a problem hiding this comment.
Maybe @jwr1 has a better implementation idea? Using more native documentation build framework.
There was a problem hiding this comment.
Unfortunately, I do not have any ideas for a better way to do this.
It is pretty cool to have this automated though (versus needing to manually update it).
There was a problem hiding this comment.
That I fully agree, I'm always pro automation whenever possible!
CollectionFactoryfor easy access to the generator methods@contextDocumentationGenerateFederationCommandwhich will be called from the frontend build