-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
[Refactor] docs directory structure #3071
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
[Refactor] docs directory structure #3071
Conversation
Codecov Report
@@ Coverage Diff @@
## next #3071 +/- ##
=======================================
Coverage ? 82.42%
=======================================
Files ? 62
Lines ? 1485
Branches ? 652
=======================================
Hits ? 1224
Misses ? 259
Partials ? 2
Continue to review full report at Codecov.
|
arpitBhalla
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What kind of change does this PR introduce?
Improvises the docs directory structure such that the fixed files are maintained under respective folders.
Did you add tests for your changes?
Not required
If relevant, did you update the documentation?
Yes, I have refactored the documentation itself.
Summary
This introduces 3 new folders separating basic, main, universe, repo docs and having the markdown files within the respective folders.
Does this PR introduce a breaking change?
No.
Other information
Not required.
|
Can you briefly explain about all theses |
|
@pranshuchittora Can we do like this? |
|
@pranshuchittora Basically, now the docs directory has all the docs in the same directory. What I have done is that I have segregated the docs on the basis of purpose.
The purpose of doing this is that when the documentation would be generated automatically, the main folder will have the package-related documentation and the other two are left un-hampered. The Components section of sidebars.json will also be generated manually this way following the same directory structure. |
|
@arpitBhalla Thanks for your views, currently the docs have the same pattern. I will obviously add nesting for compound components while generating their documentation :) |
This looks great. We need to make the following changes in the Playground as well because it fetches these docs on build time. Else looks good to me |
|
Okay, I will check that too, I was a bit zoned out about the playground for the following change. |

What kind of change does this PR introduce?
Improvises the docs directory structure such that the fixed files are maintained under respective folders.
Did you add tests for your changes?
Not required
If relevant, did you update the documentation?
Yes, I have refactored the documentation itself.
Summary
This introduces 3 new folders separating
main, universe, repodocs and having the markdown files within the respective folders.Does this PR introduce a breaking change?
No.
Other information
Not required.