MLH Fellowship 2020 Ideas List #2267

yangshun · 2020-02-05T15:59:23Z

Note that all the projects listed here are targeting Docusaurus 2.

New Themes and Theme Gallery

Difficulty: Medium

Description: Docusaurus 2 introduces the concepts of themes and we have created an entirely new CSS framework from scratch based on Docusaurus 1's theme. Some users will want to use their own CSS, for e.g. Bootstrap. Hence we want to add support for themes based on the popular CSS frameworks out there (e.g. Bootstrap, Bulma). It'd also be nice to have a gallery where we can showcase the themes.

edit: #3522

Docusaurus Debug Dashboard

Difficulty: Medium

Description: A dashboard page that could be accessed during development to show the available routes for a Docusaurus site and also the list of swizzled components. This helps users to easily identify problems in a Docusaurus set up and enhances the user/developer experience. For example, a user can access http://localhost:3000/__docusaurus/debug to see helpful debug information.

This is similar to http://localhost:3000/rails/info/routes in Rails, see the docs.

Bonus points if we can swizzle components from the UI!

Edit: done

Docusaurus 1 to 2 Migration Command

Create a CLI command that can be run on Docusaurus 1 projects to easily move them to Docusaurus 2! There will still be some manual tweaking involved but at least it can help to get the trivial stuff out of the way.

This tool will essentially be a programmatic version of our migration guide.

Edit: done but can be improved here: #3520

Docusaurus Doctor

Difficulty: Hard

Description: A command that can be used to check for common issues or recommend best practices within a Docusaurus website, for e.g. finding broken page paths, finding broken image paths, flagging unused assets, etc. Alternatively, these checks can be in the form of new ESLint rules/static analysis.

edit: not sure it's needed anymore?

Offline Search

Difficulty: Hard

Description: Docusaurus uses Algolia as the default search service but internal docs cannot leverage on Algolia, which requires that a website be public. It could be possible to use lunr.js to build an index of the content and add search as a built-in feature to a Docusaurus website. This project is inspired by our Canny Feedback board.

edit: pending PR: #3153

Integrate Build Size Bot

Difficulty: Easy

Integrate build size bot (or alternatives) to run on PRs to detect size regressions whenever changes are made to the repository. Example of Next.js PR

edit: #3521

Keyboard Shortcuts

Edit slorber => #3020

yangshun · 2020-02-24T03:08:40Z

Docusaurus wasn't selected for Google Summer of Code 2020. I guess we can keep this open as the ideas are still useful

yangshun · 2020-05-28T01:07:39Z

Repurposing this list to be MLH Fellowship instead of GSoC.

slorber · 2020-06-05T16:03:54Z

Dynamic Social Cards

Edit: moved to #2968

teikjun · 2020-06-12T15:10:55Z

Hi @yangshun, @anshulrgoyal and I are thinking of working on Docusaurus 1 to 2 Migration Command. May I ask for a quick estimate for the difficulty level and priority level of this issue?
(Edit: We got a reply from Joel already, thanks!)

gedeagas · 2020-06-18T12:09:58Z

Dynamic Social Cards

Moved to #2968

Interesting idea, i have somewhat simmilar project like this.
https://og.agas.dev/**Contoh**%20Self%20Hosted%20Image%20Overlay%20Server.png?footer=Agastya%20Darma&md=1&imageUrl=https%3A%2F%2Fimages.unsplash.com%2Fphoto-1480796927426-f609979314bd%3Fixlib%3Drb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1950&q=80.png&fbclid=IwAR0Um7zFu-Q33nBhh2IeloEV4M-0ZLuL6bONoiQ4UL0ok3BnFQi9XQn7X-c.

is anyone working on this?

slorber · 2020-06-19T09:50:06Z

Hi,

I've created a dedicated issue for dynamic social cards here: #2968

@Drewbi wants to work on this already

anshulrgoyal · 2020-06-25T12:17:09Z

Hi,
For the migration tool should we create a separate tool like docusaurus-migrate or we add it to the existing package?. I think the new tool will be better.

yangshun · 2020-06-25T12:45:42Z

I'd say a new package within this repo under the @docusaurus/ scope. We don't want code to be all over the place otherwise it becomes hard to keep track and also enable publishing permissions. We'll also be the maintainers of it moving forward.

slorber · 2020-06-25T13:37:17Z

I think the question was more if we integrate the migration as part of the existing cli, or if we create a dedicated cli for the migration. (in all case it stays on this repo).

I think it would be better to create a new package like "@docusaurus/migrate", because it's likely to be run one time with npx, and after the user don't need it anymore, so including this to core cli system is not very useful. It's a bit similar to "@docusaurus/init"

yangshun · 2020-06-25T14:24:43Z

Oh yes I fully agree. @docusaurus/migrate sounds good (hopefully we don't need it for a 2 to 3 migration hehe

anshulrgoyal · 2020-07-08T09:52:44Z

I want to work on the search feature.

JoelMarcey · 2020-09-25T21:21:54Z

@yangshun, @slorber -- which of these are actually completed? Thanks!

slorber · 2020-09-28T13:17:43Z

@JoelMarcey

Done:

Docusaurus Debug Dashboard => done
Docusaurus 1 to 2 Migration Command => done (but could still be improved)
Docusaurus Doctor => somehow related to the debug dashboard, and I'm not even sure this is needed anymore because we worked on making v2 much more failsafe and added broken links checking etc

Pending:

Offline Search => pending PR, will review it carefully after i18n
Dynamic Social Cards => pending PR but need more work

Not started:

New Themes and Theme Gallery (the bootstrap theme is quite basic, and could be enhanced)
Build Size Bot
Keyboard shortcuts

slorber · 2020-10-02T13:56:32Z

Meta issue for the MLH 2nd batch tasks: #3527

Let's close this one for now

sarthakkundra · 2020-11-24T22:20:42Z

@yangshun Any plans of applying Docusaurus to GSoC 2021?

yangshun · 2020-11-25T03:01:14Z

We would try I guess.

…

On Wed, Nov 25, 2020, 6:20 AM Sarthak kundra ***@***.***> wrote: @yangshun <https://github.com/yangshun> Any plans of applying Docusaurus to GSoC 2021? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2267 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKBCHIDS7HIRVJKX5XGIFTSRQWURANCNFSM4KQNTCZQ> .

sarthakkundra · 2020-11-25T06:36:11Z

D2 has definitely matured a lot since the last application so I'm thinking it'll be worth a shot.

sarthakkundra · 2021-01-06T10:37:25Z

@yangshun if you're trying for GSoC 2021 I believe you will be brainstorming about possible projects. Contributing here for some time now and I think I might have some ideas. Should I create issues for them or mail someone?

yangshun · 2021-01-06T16:58:06Z

For maximum visibility sake, creating new issues would be good so that even if we don't apply for GSoC or don't get selected for it, others can still pick them up.

yangshun added the gsoc label Feb 5, 2020

yangshun removed the gsoc label Feb 23, 2020

yangshun changed the title ~~Google Summer of Code 2020 Ideas List~~ MLH Fellowship 2020 Ideas List May 28, 2020

yangshun pinned this issue Jun 4, 2020

yangshun added the mlh Major League Hacking Fellowship label Jun 5, 2020

SamChou19815 mentioned this issue Jun 13, 2020

feat(v2): Implement proof-of-concept Docusaurus Debug Dashboard #2928

Merged

teikjun mentioned this issue Jun 15, 2020

RFC: Option validation approach for themes and plugins MLH-Fellowship/docusaurus#8

Closed

slorber mentioned this issue Jun 19, 2020

RFC: social cards #2968

Open

slorber mentioned this issue Jul 1, 2020

RFC: Keyboard Shortcuts #3020

Open

slorber mentioned this issue Aug 31, 2020

Proposal: prevent @docusaurus package version mismatches #3371

Closed

slorber mentioned this issue Oct 2, 2020

MLH fellowship - batch 2 #3527

Closed

slorber closed this as completed Oct 2, 2020

yangshun unpinned this issue Oct 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MLH Fellowship 2020 Ideas List #2267

MLH Fellowship 2020 Ideas List #2267

yangshun commented Feb 5, 2020 •

edited by slorber

Loading

yangshun commented Feb 24, 2020

yangshun commented May 28, 2020

slorber commented Jun 5, 2020 •

edited

Loading

teikjun commented Jun 12, 2020 •

edited

Loading

gedeagas commented Jun 18, 2020 •

edited by slorber

Loading

Dynamic Social Cards

slorber commented Jun 19, 2020

anshulrgoyal commented Jun 25, 2020 •

edited

Loading

yangshun commented Jun 25, 2020 •

edited

Loading

slorber commented Jun 25, 2020 •

edited

Loading

yangshun commented Jun 25, 2020

anshulrgoyal commented Jul 8, 2020

JoelMarcey commented Sep 25, 2020

slorber commented Sep 28, 2020 •

edited

Loading

slorber commented Oct 2, 2020 •

edited

Loading

sarthakkundra commented Nov 24, 2020

yangshun commented Nov 25, 2020 via email

sarthakkundra commented Nov 25, 2020 •

edited

Loading

sarthakkundra commented Jan 6, 2021

yangshun commented Jan 6, 2021

MLH Fellowship 2020 Ideas List #2267

MLH Fellowship 2020 Ideas List #2267

Comments

yangshun commented Feb 5, 2020 • edited by slorber Loading

New Themes and Theme Gallery

Docusaurus Debug Dashboard

Docusaurus 1 to 2 Migration Command

Docusaurus Doctor

Offline Search

Integrate Build Size Bot

Keyboard Shortcuts

yangshun commented Feb 24, 2020

yangshun commented May 28, 2020

slorber commented Jun 5, 2020 • edited Loading

Dynamic Social Cards

teikjun commented Jun 12, 2020 • edited Loading

gedeagas commented Jun 18, 2020 • edited by slorber Loading

Dynamic Social Cards

slorber commented Jun 19, 2020

anshulrgoyal commented Jun 25, 2020 • edited Loading

yangshun commented Jun 25, 2020 • edited Loading

slorber commented Jun 25, 2020 • edited Loading

yangshun commented Jun 25, 2020

anshulrgoyal commented Jul 8, 2020

JoelMarcey commented Sep 25, 2020

slorber commented Sep 28, 2020 • edited Loading

slorber commented Oct 2, 2020 • edited Loading

sarthakkundra commented Nov 24, 2020

yangshun commented Nov 25, 2020 via email

sarthakkundra commented Nov 25, 2020 • edited Loading

sarthakkundra commented Jan 6, 2021

yangshun commented Jan 6, 2021

yangshun commented Feb 5, 2020 •

edited by slorber

Loading

slorber commented Jun 5, 2020 •

edited

Loading

teikjun commented Jun 12, 2020 •

edited

Loading

gedeagas commented Jun 18, 2020 •

edited by slorber

Loading

anshulrgoyal commented Jun 25, 2020 •

edited

Loading

yangshun commented Jun 25, 2020 •

edited

Loading

slorber commented Jun 25, 2020 •

edited

Loading

slorber commented Sep 28, 2020 •

edited

Loading

slorber commented Oct 2, 2020 •

edited

Loading

sarthakkundra commented Nov 25, 2020 •

edited

Loading