You can help improve MDriven documentation and reusable examples by reporting missing information, suggesting links, and contributing through the available wiki and GitHub paths.
Contribute to MDriven
MDriven welcomes suggestions, ideas, and opinions that make information easier for MDriven users to find and use. The wiki is maintained as a place where you can find answers, examples, and connected topics.
Suggest documentation improvements
Report information that is missing, unclear, or difficult to find. Include the task you were trying to complete and the information you expected to find.
For example, if you are working with a ViewModel and cannot find an explanation of an OCL operator, suggest the missing topic and describe the model situation where you needed it.
Useful suggestions include:
- A missing documentation topic.
- An explanation or example that needs clarification.
- A wiki navigation path that does not support the way you work.
- A related article that should be linked from the current page.
- An external reference that explains a related standard or operator.
Improve wiki links
Wiki links help readers continue from one concept to the next. When you have write access, add a link when you find a page that is not connected to another topic you need.
For example, link an article about a ViewModel to the relevant OCL guidance when the article uses an OCL expression. This helps the next reader move from the UI concept to the expression language without repeating the search.
Contribute reusable GitHub material
MDriven's GitHub repository contains sample models, mergeable models, and reusable components. Use these materials in your own projects and contribute material that other MDriven users can reuse.
Examples of reusable material include:
- A sample model that demonstrates a focused modeling scenario.
- A mergeable model for use in another project.
- A reusable component, such as a component for AngularJS or the Blazor client implementation.
Visit MDrivenComponents on GitHub to explore the available repository.
Get involved
MDriven can provide wiki write access to people who want to help improve the documentation. Start by identifying a specific improvement, such as a missing link between two related pages or an example that would make a topic clearer.