How to use GitHub’s search feature to search the wiki

[MohitGupta121]

Explanation

How to use GitHub’s search feature to search the wiki

• With this contributor easily search and navigate to desire wiki page.
• Added TOC in all wikis pages.

Essential Checklist

• The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
• Any changes to scripts/assets files have their rationale included in the PR explanation.
• The PR follows the style guide.
• The PR does not contain any unnecessary code changes from Android Studio (reference).
• The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
• The PR is assigned to the appropriate reviewers (reference).

For UI-specific PRs only

If your PR includes UI-related changes, then:

• Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes
• For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see RTL guide)
• Add a video showing the full UX flow with a screen reader enabled (see accessibility guide)
• Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing

[MohitGupta121]

@BenHenning @seanlip PTAL,

In last welfare meeting I discussed the problem that we have enough infomation in wiki but contributors not able to reach it. So the solution is GitHub search feature which helps to search into wiki (I think most of the new contributors even I not know that apart from code, we also search into wiki with GitHub search feature.).

So I decied to add Gif to demostrate this feature both in oppia and oppia-android after discussing with Chris.
Also I decided to add missing TOC in oppia-android wiki page which make searcing easy.

Thanks.

[seanlip]

Thanks @MohitGupta121. Two questions:

(a) Perhaps this should be on the "Coders" page instead, since the home page is meant to be more generic for different types of volunteers? Alternatively, you can have it at the bottom of the page in a separate section ("How to find information on this wiki").

(b) You mention adding a TOC, but I don't see it?

[MohitGupta121]

@seanlip Thanks for review,
a) Actually Chris suggest to keep it on Home page that's why, But I will move it to coders.
b) Regarding TOC, I waiting for your suggestions (if any) to go ahead, that's why I not update it here. But now you allow I will update that also.

Thanks.

[seanlip]

Hm, for (b), this wasn't clear from your previous comment. I can't approve it since I don't know what you are proposing exactly, but in the future I suggest making the changes you think would be best and then sending that entire PR for review -- it speeds up the process.

[MohitGupta121]

Okay Thanks @seanlip, I keep this in mind and act accordingly.

[MohitGupta121]

@seanlip PTAL, Thanks.
I added TOC to most of the wiki related to oppia-android codebase. But not for some general wikis such as "Our Mission", and "SLoP-2020".
If we need TOC for that wikis also please let me know.
Thanks.

[seanlip]

Thanks @MohitGupta121, I generally have no concerns. Just noticed one minor thing.

[seanlip]

Thanks @MohitGupta121, LGTM!

[MohitGupta121]

@seanlip PTAL, replace all other Tabs to spaces.
Thanks.

[oppiabot]

Unassigning @MohitGupta121 since a re-review was requested. @MohitGupta121, please make sure you have addressed all review comments. Thanks!

[BenHenning]

Thanks @MohitGupta121! LGTM for textproto change.

Note I didn't review the wiki files in detail since @seanlip already approved, but I can take a pass if you need me to.

[oppiabot]

Hi @MohitGupta121, this PR is ready to be merged. Please address any remaining comments prior to merging, and feel free to merge this PR once the CI checks pass and you're happy with it. Thanks!

[BenHenning]

Thanks @MohitGupta121! The new search feature LGTM as well.

[oppiabot]

Hi @MohitGupta121, this PR is ready to be merged. Please address any remaining comments prior to merging, and feel free to merge this PR once the CI checks pass and you're happy with it. Thanks!

[MohitGupta121]

@BenHenning Do I need to add new TODO issue for wiki update when GitHub new search feature release?

And Will you please merge this, if nothing unresolved. Thanks!

[BenHenning]

@BenHenning Do I need to add new TODO issue for wiki update when GitHub new search feature release?

And Will you please merge this, if nothing unresolved. Thanks!

A TODO isn't necessary, I think. We can update this reactively as the flow on GitHub isn't changing too drastically.