farhan5248 / sheep-dog-tools

Eclipse and Maven plug-ins to help manual testers support developers adopting bdd and tdd using lean principles and model based testing
GNU General Public License v3.0
0 stars 0 forks source link

Create documentation for Xtext grammar definition and how to use the API to format a file and use colours #23

Closed farhan5248 closed 11 months ago

farhan5248 commented 11 months ago

Document the following

  1. Code Generation: Point out the different ways to define the elements like Steps vs DocString/DataTable
  2. Formatting: Explain what the related generated code looks like and how to access the grammar
  3. Syntax Colouring: Explain how to highlight specific nodes like GWTAB* and tags vs parameters (not defined in grammar)
  4. Explain the current benefit of having semantic validation to create valid paths, syntax validation to create valid nodes/vertices
  5. Explain the next benefit of code generation from UML model and test case generation from graph model.
farhan5248 commented 11 months ago

Make updates to the Xtext parent README.md file

  1. Update Test the Setup section, run tests with mvn test doesn't actually run the tests for now, so use mvn package
  2. Update the list of files to change by project, dsl, tests, UI and then purpose, language def, validation, formatting, highlighting, code generation, CI (Move Publish New Version section here). Make this a table with links.
  3. The links should be to pages describing 1-3 in the description above
  4. In the parent README, explain 4 and 5 in the description above and where the editor is used in the P diagram.
  5. In the repo README, in the Project Structure section, create a new table with an additional column for the different file types. Also remove the main code and test code rows
farhan5248 commented 11 months ago

Test the Setup section updated

farhan5248 commented 11 months ago

Next week I start using Maven to find files by tag for batch processing. I will also create the PST with UML. After that I'll create the PIT with JUNG, then Adoc files from JUNG. Graphwalker converts the graph model into the UML model and possible vice versa

farhan5248 commented 11 months ago

Markdown files updated, will work on Prezi next.

farhan5248 commented 11 months ago

I updated the sketches for the next Prezi updates but I'll do that later this week when I have finished all the Xtext work.