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

Add StartScreen to AppInfo #47

Closed
P3N-101 opened this issue Nov 8, 2021 · 2 comments
Closed

Add StartScreen to AppInfo #47

P3N-101 opened this issue Nov 8, 2021 · 2 comments

Comments

@P3N-101
Copy link

P3N-101 commented Nov 8, 2021

As the StartScreen app variable is now available it should be documented.

In the attached documentation.py I have added the following;

start_screen = app_screen[1]["App As appinfo"].get("StartScreen")

at line 172 and the following in the # write app info block

  if start_screen != None:
            appinfo = self._extract_parts_from_propperty(start_screen)
            if appinfo[1] != None:
                self.md_file.new_paragraph(appinfo[1])
            self.md_file.new_line("")
            self.md_file.new_header(level=2, title="StartScreen")
            self.md_file.insert_code(appinfo[2],language='typescript')
            self.md_file.new_line("")

This also has some updates to Mermaid to work OOTB with Docusaurus, namely ==> becomes --> and screen names cannot have spaces, well I haven't worked out how to yet. Working on Datasources and Tests next :)

documentation - Copy.txt

@sebastian-muthwill
Copy link
Owner

Thx for your participation. I took over the changes for StartScreen.

Is Docusaurus mermaid not supporting the ==> syntax? This is a standard for bald lines in mermaid.
I check on this

@sebastian-muthwill
Copy link
Owner

The mermaid implementation was wrong. I changed it to the propper synthax based on mermaid documentations.

Here is the new example how it will be represented with spaces in Screen names. find example here

@sebastian-muthwill sebastian-muthwill added this to To do in Development Board via automation Nov 9, 2021
@sebastian-muthwill sebastian-muthwill moved this from To do to In progress in Development Board Nov 9, 2021
@sebastian-muthwill sebastian-muthwill moved this from In progress to Done in Development Board Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

2 participants