Documentation Testing

[JeremyTubongbanua]

Skills

Some of the skills you may see yourself applying:

• Java
• Dart/Flutter
• Problem Solving
• English

What needs to be done

• Review docs.atsign.com and give feedback on how well the concurrent documentation is explained
• Find bugs, outdated content, typos, and/or grammatical errors
• Give your thoughts! Everything and anything is appreciated.
• Feel free to make a PR if you'd like to get your hands dirty and fix our docs site yourself!

Java Documentation Testnig

• https://docs.atsign.com/start/java/
• https://docs.atsign.com/sdk/java/introduction/
• Those two links above are very new and need verification and testing on other machines. Let us know if the documentation works and is explained clearly.

Support

In case you need any kind of help (such as getting your environment setup or asking questions about our tech) don’t be afraid to ask in our discord. There is a team full of developers ready to jump in and help on whatever your issue may be.

[ruqaiyasattar]

Hi, there this is some typo bugs

[JeremyTubongbanua]

Hey @ruqaiyasattar, thanks for taking interest!

Where exactly did you find these typos/bugs? Could you please jot down the links? Thank you!

[DonnC]

@JeremyTubongbanua hie
I just realized that the links on Get Started Page are not directing to the respective pages
For Flutter and IoT they redirect to the same start page instead of https://docs.atsign.com/start/flutter/ for flutter and https://docs.atsign.com/start/iot/ for IoT

And the Java link is directing to sdk page too

The reference page

[PriyanshuRj]

Hey, I Found some Issues

1. Redirecting issues on the home page of the documentation, The get started link for Flutter and IoT is Redirecting to the same page while the one for Java is redirecting to the SDK reference page while they should redirect to the respective get started pages -
   https://docs.atsign.com/start/flutter/ (for flutter),
   https://docs.atsign.com/start/iot/ (for IoT),
   https://docs.atsign.com/start/java/ (for Java)

2. The Links for Visual Studio Code (https://code.visualstudio.com/) and Android Studio (https://developer.android.com/studio) should be redirected to a new page not the same page but they are redirecting on the same page.
   

The same goes for Install flutter on your device page the installation links for macOS, Windows and Linux redirect on the same page and at_app Link at step 3 and 4

Can I create a PR to rectify it?

[JeremyTubongbanua]

@JeremyTubongbanua hie I just realized that the links on Get Started Page are not directing to the respective pages For Flutter and IoT they redirect to the same start page instead of https://docs.atsign.com/start/flutter/ for flutter and https://docs.atsign.com/start/iot/ for IoT

And the Java link is directing to sdk page too

The reference page

Hey @DonnC, thanks for taking interest :).

Somebody is already working on that case in #162. However, we will add you to the queue in case we decide not to take the PR or if the assignee withdraws. Thanks!

[JeremyTubongbanua]

Hey, I Found some Issues

1. Redirecting issues on the home page of the documentation, The get started link for Flutter and IoT is Redirecting to the same page while the one for Java is redirecting to the SDK reference page while they should redirect to the respective get started pages -
   https://docs.atsign.com/start/flutter/ (for flutter),
   https://docs.atsign.com/start/iot/ (for IoT),
   https://docs.atsign.com/start/java/ (for Java)
2. The Links for Visual Studio Code (https://code.visualstudio.com/) and Android Studio (https://developer.android.com/studio) should be redirected to a new page not the same page but they are redirecting on the same page.
   

The same goes for Install flutter on your device page the installation links for macOS, Windows and Linux redirect on the same page and at_app Link at step 3 and 4

Can I create a PR to rectify it?

Hey @PriyanshuRj thanks for taking interest

We've got somebody working on (1) already in #162 .

However, we'd love for you to make a PR on everything below (2). =) I'll add you as an assignee to this ticket.

[PriyanshuRj]

Hey @JeremyTubongbanua I did the required the changes and created a pull request #167 can you please review it.

[depimomo]

Hi! When I'm browsing through the codelabs, I found that the steps sidebar and the content is too close, sometimes it's make it hard to read. Find some example below:

my suggestion is to make some padding on the sidebar, or even create a divider so it'll be more clear. What do you think @JeremyTubongbanua ? Is it possible? If yes, I'd be glad to work on it!

[JeremyTubongbanua]

Hi! When I'm browsing through the codelabs, I found that the steps sidebar and the content is too close, sometimes it's make it hard to read. Find some example below:

my suggestion is to make some padding on the sidebar, or even create a divider so it'll be more clear. What do you think @JeremyTubongbanua ? Is it possible? If yes, I'd be glad to work on it!

That's a great suggestion @depimomo.

Take a look through layouts/ for the layout that is being used for this page. (Should be a codelab single?) I'll assign you to this ticket as well. :)

[depimomo]

okay, will take a look at it!

[PriyanshuRj]

Hi, when using the search functionality the searches are often crossing the designated area due to a single word having size more than the provided space we can introduce word wrap here.
Here is the screenshot of the same issue

Notice getting secondary address crossing that light gray border.
I would love to work on this issue.

[JeremyTubongbanua]

Hi, when using the search functionality the searches are often crossing the designated area due to a single word having size more than the provided space we can introduce word wrap here. Here is the screenshot of the same issue Notice getting secondary address crossing that light gray border. I would love to work on this issue.

Hey @PriyanshuRj thanks for finding this. Could you please create a separate GitHub issue describing this problem? I will assign it to you and assign it the hacktoberfest tag. Good find!

[PriyanshuRj]

Hi, when using the search functionality the searches are often crossing the designated area due to a single word having size more than the provided space we can introduce word wrap here. Here is the screenshot of the same issue Notice getting secondary address crossing that light gray border. I would love to work on this issue.

Hey @PriyanshuRj thanks for finding this. Could you please create a separate GitHub issue describing this problem? I will assign it to you and assign it the hacktoberfest tag. Good find!

Done #199