Create a User Guide - Githubissues

opencaesar / oml-vision

A VS Code extension providing UI viewpoints for OML models

Other

4 stars 2 forks source link

Create a User Guide #8

Closed pogi7 closed 7 months ago

pogi7 commented 8 months ago

Checklist before submitting a feature request

[x] I have reviewed CONTRIBUTING.md document
[x] I have done a quick search on the issue tracker to check if the feature request is not redundant

Is your feature request related to a problem? If yes, describe the problem

I am annoyed that there is not a user guide.

Describe the desired feature

OML Vision should have a user guide which includes the following

Install VS-Code Extention
Sample OML model
Starting or Entry point
Pages view layouts, how to configure, how to start
Table view layouts, how to configure, how to start
Tree view layouts, how to configure, how to start
Diagram view layouts, how to configure, how to start

Additional context

Examples of good software documentation:

pogi7 commented 7 months ago

Work completed here https://github.com/opencaesar/oml-vision-docs/pull/1