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

[Enhancement] Create codegen featureset/delta documentation table #444

Open
timothytavarez opened this issue Aug 16, 2023 · 5 comments
Open
Assignees

Comments

@timothytavarez
Copy link

It would make adoption more manageable for codegen if we can clearly articulate differences in compiled results. At a minimum, we should develop a documentation summary with featuresets (e.g., inheritance, metamodel differences, etc.) that can be easily grasped at a high level.

Today, language deltas are documented separately for each codegen subtarget. By putting it in a single view, we can more readily understand differences, expected results, etc.

@timothytavarez
Copy link
Author

I'll be happy to support adding/updating this documentation.

@dselman
Copy link
Contributor

dselman commented Dec 6, 2024

That would be great, thanks!

@Mamatha1718
Copy link

Hi @dselman, @timothytavarez
I am eager to tackle this issue. I would like to add these changes:
1.Unified Featureset Documentation:
I will create consolidated table summarizing key features and differences across all
=>Inheritance models (e.g., single, multiple, multilevel).
=>Metamodel differences (e.g., UML compliance or custom models).
=>Platform-specific constraints or optimizations.
2. Comparison of Compiled Results:
I will document examples of compiled results for each subtarget with side-by-side
comparisons to highlight key differences.
3. Language-Specific Notes:
I will add include unique features, limitations specific to each subtarget, along with code snippets for better clarity.
4. Troubleshooting and FAQ's :
addressing some common potential issues users may face. while working on
different subtargets.
5. Guidelines for Future Contributors:
Include a template or checklists for future contributors to maintain and update
the documentation effectively.
could you please clarify where i will start to work on this issue. and will you please let me know if there are another changes required.

@sanketshevkar
Copy link
Member

Thanks @Mamatha1718 this sounds awesome!
You might want to add these details to the tech-docs repo and link it in the readme for concerto-codegen.

@sanketshevkar sanketshevkar transferred this issue from accordproject/concerto-codegen Jan 2, 2025
@Mamatha1718
Copy link

Mamatha1718 commented Jan 3, 2025

Hi @sanketshevkar ,

Thank you for your response and for assigning me this issue. Should I add these changes to an existing file? I’m a little confused about which specific file needs these changes. Could you please clarify?

Thanks for your help!

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

No branches or pull requests

4 participants