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

Organize siteConfig.js options documentation page better #436

Closed
1 of 3 tasks
JoelMarcey opened this issue Feb 4, 2018 · 9 comments
Closed
1 of 3 tasks

Organize siteConfig.js options documentation page better #436

JoelMarcey opened this issue Feb 4, 2018 · 9 comments
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. status: claimed Issue has been claimed by a contributor who plans to work on it.

Comments

@JoelMarcey
Copy link
Contributor

JoelMarcey commented Feb 4, 2018

Some ideas:

  • Better categorization
  • Alphabetize
  • Table format

Is this a bug report?

No. It is more of an efficiency report.

Have you read the Contributing Guidelines?

Yes.

Environment

N/A

Steps to Reproduce

  1. Go to https://docusaurus.io/docs/en/site-config.html
  2. See how the options are kinda scattered all over

Expected Behavior

Better readability

Actual Behavior

Random readability

Reproducible Demo

https://docusaurus.io/docs/en/site-config.html

@JoelMarcey JoelMarcey added good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. documentation The issue is related to the documentation of Docusaurus labels Feb 4, 2018
haraldur12 pushed a commit to haraldur12/Docusaurus that referenced this issue Feb 6, 2018
@InternetExplorer7
Copy link
Contributor

Hi, can I take on the other 2/3 issues?

@yangshun
Copy link
Contributor

yangshun commented May 4, 2018

@InternetExplorer7 How's your progress for this task? Let us know how we can help. If you are no longer available for this task, just let us know and we can free it up for someone else. Do keep us updated 😄

@InternetExplorer7
Copy link
Contributor

I was just doing this for a class - so please feel free to reassign the task!

@yangshun yangshun removed the status: claimed Issue has been claimed by a contributor who plans to work on it. label May 4, 2018
@johnotu
Copy link

johnotu commented May 24, 2018

I looked at the page but couldn't understand how "scattered" they are. Would sectioning them into tables or div groups fix it?

@sujono91
Copy link
Contributor

@JoelMarcey @yangshun
I'm interested to work on this categorization issue. My proposal (just an example):

Mandatory Fields
Header
headerIcon - ...
headerLinks - ..
Optional Fields
Media Social
facebookAppId - ..
facebookComments - ..

If u've any categorization proposal before, pls lmk. I'll try to categorize all of them and give a full proposal here 👍

@JoelMarcey JoelMarcey added the status: claimed Issue has been claimed by a contributor who plans to work on it. label Jun 1, 2018
@JoelMarcey
Copy link
Contributor Author

@sujono91 We would love for you to take this issue if you are interested, thanks!

@sujono91
Copy link
Contributor

sujono91 commented Jun 3, 2018

@JoelMarcey sure.. will propose the categorization on this EoW

@endiliey endiliey added mentorship difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. and removed status: claimed Issue has been claimed by a contributor who plans to work on it. labels Aug 28, 2018
@tanhauhau
Copy link
Contributor

Hi, how is the issue? i see it's a good first issue, can i take on it?

@JoelMarcey JoelMarcey added the status: claimed Issue has been claimed by a contributor who plans to work on it. label Oct 9, 2018
@JoelMarcey
Copy link
Contributor Author

Hi @tanhauhau - sure. You can own this, thank you! I would make sure you keep in coordination with #946 (comment) as we are creating tabs for this page. But the content of the siteConfig Fields section can be modified as well.

We've added an issue: claimed label so that others will know not to start work on the issue. If you change your mind about the issue, no worries! Just let us know so that we can remove the label and free it up for someone else to claim.

We will check in with you periodically so that we can keep the task updated with the progress.

tanhauhau added a commit to tanhauhau/Docusaurus that referenced this issue Oct 10, 2018
tanhauhau added a commit to tanhauhau/Docusaurus that referenced this issue Oct 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. status: claimed Issue has been claimed by a contributor who plans to work on it.
Projects
None yet
Development

No branches or pull requests

7 participants