Docusaurus: Organize siteConfig.js options documentation page better

Created on 4 Feb 2018  路  9Comments  路  Source: facebook/docusaurus

Some ideas:

  • [ ] Better categorization
  • [X] 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
    3.

Expected Behavior

Better readability

Actual Behavior

Random readability

Reproducible Demo

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

starter documentation good first issue claimed

All 9 comments

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

@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 馃槃

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

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

@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 馃憤

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

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

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

Hi @tanhauhau - sure. You can own this, thank you! I would make sure you keep in coordination with https://github.com/facebook/Docusaurus/pull/946#issuecomment-428159560 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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

endiliey picture endiliey  路  3Comments

microbouji picture microbouji  路  3Comments

azu picture azu  路  3Comments

JoelMarcey picture JoelMarcey  路  3Comments

omry picture omry  路  3Comments