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

[WIP] Added text to speech instructions #171

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

meenbeese
Copy link
Collaborator

@meenbeese meenbeese commented Sep 16, 2023

Revives the TTS PR by improving upon it. The current solution that I managed to implement is not final and should be iterated before merging. The FAQ living in the main page is not ideal because it should be in the header bar and in its own page instead so it can be linked easily from the main app.

I know that this is a PR that stalled for too long and is important for many issues to be resolved in Organic Maps. Can you take a look so we can discuss/make the necessary improvements and merge it as soon as possible @biodranik ?

Closes #6
Closes #32
Closes #115

@meenbeese meenbeese force-pushed the tts-instructions branch 2 times, most recently from 0720eb0 to 6ee4708 Compare September 16, 2023 22:42
@biodranik
Copy link
Member

Html file in shortcodes doesn't look right. How it should be translated? Let's create a faq section first, and add it into the top menu.

@meenbeese
Copy link
Collaborator Author

meenbeese commented Sep 17, 2023

Html file in shortcodes doesn't look right.

I agree with you. The reason I went with html is because I kept getting weird errors with markdown that I couldn’t resolve and html was much easier to work with.

How it should be translated? Let's create a faq section first, and add it into the top menu.

This makes a lot of sense. In that case, should I incorporate the work from #115 into this PR too? There is no need to duplicate all that work that was already done.

@biodranik
Copy link
Member

What kind of weird errors did you get with markdown?

Yes, you can incorporate changes from that pr. But we need a separate section, not a single FAQ page. See #6

@meenbeese
Copy link
Collaborator Author

What kind of weird errors did you get with markdown?

I get this error when trying to call the screenshots function from markdown:
Error: Failed to build the site Error: Failed to render content of \\?\C:\Users\meenbeese\OneDrive\Documents\GitHub\organicmaps.github.io\content\_index.md Error: Reason: Failed to render tts_testing shortcode Error: Reason: Failed to render 'shortcodes/tts_testing.md' Error: Reason: Function 'screenshot' not found

And when I remove the function call to integrate them directly into md, they don't render at all.
I don't have any of these problems with HTML so I think I will use that for the PR.

Yes, you can incorporate changes from that pr. But we need a separate section, not a single FAQ page. See #6

You mean like adding it to the top bar, right? If so, I will start working on that now.
Screenshot 2023-09-17 165100

Do you have an idea of where it would be best to add it? Before the news, or after Github for example?

@meenbeese meenbeese marked this pull request as draft September 18, 2023 01:01
@meenbeese
Copy link
Collaborator Author

meenbeese commented Sep 18, 2023

Never mind the previous errors as I figured out how to implement it using HTML. The only thing needed now is the taxonomy you mentioned previously in a linked issue so that every FAQ question has its own markdown file. Then, it will be easier to add several different FAQ titles, translate them and link them from the main app as necessary.

Screenshot 2023-09-17 223151

@meenbeese meenbeese temporarily deployed to production September 19, 2023 20:49 — with GitHub Actions Inactive
Copy link
Member

@biodranik biodranik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great to preview it! Hint: provide a branch preview link instead of a commit link, it will be automatically updated after any changes.

content/faq/index.md Outdated Show resolved Hide resolved
content/faq/index.md Outdated Show resolved Hide resolved
content/faq/index.md Outdated Show resolved Hide resolved
content/faq/index.md Outdated Show resolved Hide resolved
content/faq/index.md Show resolved Hide resolved
@meenbeese meenbeese temporarily deployed to production September 24, 2023 02:57 — with GitHub Actions Inactive
@meenbeese meenbeese temporarily deployed to production September 24, 2023 03:02 — with GitHub Actions Inactive
@meenbeese meenbeese temporarily deployed to production September 24, 2023 20:49 — with GitHub Actions Inactive
@meenbeese meenbeese temporarily deployed to production September 24, 2023 20:51 — with GitHub Actions Inactive
@meenbeese meenbeese temporarily deployed to production September 24, 2023 21:14 — with GitHub Actions Inactive
@meenbeese meenbeese temporarily deployed to production September 24, 2023 21:18 — with GitHub Actions Inactive
@meenbeese
Copy link
Collaborator Author

It would be great to preview it! Hint: provide a branch preview link instead of a commit link, it will be automatically updated after any changes.

I agree, a preview would be nice. How can I do this?

@meenbeese meenbeese marked this pull request as ready for review September 24, 2023 21:20
install-appgallery = "Install Organic Maps from Huawei AppGallery"
install-appstore = "Install Organic Maps from the AppStore"
install-googleplay = "Install Organic Maps from Google Play"
install-fdroid="Install Organic Maps from F-Droid"
language = "English"
const_lang = "Language"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a better way to name this?

@meenbeese meenbeese temporarily deployed to production September 26, 2023 02:11 — with GitHub Actions Inactive

| | | |
| ----------- | ----------- | ----------- |
| <img src='/images/screenshots/tts_config_1.jpg' width='400' alt='Screenshot 1'> | <img src='/images/screenshots/tts_config_2.jpg' width='400' alt='Screenshot 2'> | <img src='/images/screenshots/tts_config_3.jpg' width='400' alt='Screenshot 3'> |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These alt tags are not useful at all. Please a more descriptive text.

@strump strump mentioned this pull request Oct 6, 2023
Signed-off-by: meenbeese <meenbeese@tutanota.com>

Create text-to-speech.md

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update text-to-speech.md

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Add files via upload

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update text-to-speech.md

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Added LineageOS instructions for tts

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Made small changes

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update text-to-speech.md

Signed-off-by: meenbeese <meenbeese@tutanota.com>

[WIP] Added text to speech instructions

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Add faq to top bar and use md

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Minor rewording and grammar fixes

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Add table with all languages

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update eSpeak link

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update and clarify instructions page

Signed-off-by: meenbeese <meenbeese@tutanota.com>
@meenbeese meenbeese temporarily deployed to production October 10, 2023 22:15 — with GitHub Actions Inactive
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

Successfully merging this pull request may close these issues.

Add /faq/ section
4 participants