Skip to content

Conversation

@khushal87
Copy link
Member

@khushal87 khushal87 commented Jun 7, 2021

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, repo docs and having the markdown files within the respective folders.

Does this PR introduce a breaking change?
No.

Other information
Not required.

@codecov
Copy link

codecov bot commented Jun 7, 2021

Codecov Report

❗ No coverage uploaded for pull request base (next@d2c6733). Click here to learn what that means.
The diff coverage is 89.10%.

❗ Current head 758ca36 differs from pull request most recent head f0023fc. Consider uploading reports for the commit f0023fc to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             next    #3071   +/-   ##
=======================================
  Coverage        ?   82.42%           
=======================================
  Files           ?       62           
  Lines           ?     1485           
  Branches        ?      652           
=======================================
  Hits            ?     1224           
  Misses          ?      259           
  Partials        ?        2           
Impacted Files Coverage Δ
src/config/BackgroundImage.tsx 100.00% <ø> (ø)
src/icons/Icon.tsx 97.56% <ø> (ø)
src/image/Image.tsx 92.85% <ø> (ø)
src/input/Input.tsx 100.00% <ø> (ø)
src/linearProgress/LinearProgress.tsx 93.33% <ø> (ø)
src/list/ListItem.tsx 100.00% <ø> (ø)
src/list/ListItemAccordion.tsx 3.84% <ø> (ø)
src/list/ListItemBase.tsx 100.00% <ø> (ø)
src/list/ListItemButtonGroup.tsx 50.00% <ø> (ø)
src/list/ListItemCheckBox.tsx 50.00% <ø> (ø)
... and 52 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d2c6733...f0023fc. Read the comment docs.

Copy link
Member

@arpitBhalla arpitBhalla left a 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.

@khushal87 khushal87 marked this pull request as draft June 8, 2021 13:37
@khushal87 khushal87 marked this pull request as ready for review June 8, 2021 13:46
@pranshuchittora
Copy link
Member

Can you briefly explain about all theses basic, main, universe, repo

@arpitBhalla
Copy link
Member

arpitBhalla commented Jun 8, 2021

@pranshuchittora Can we do like this?

Make Sub Category for different Components
image

@khushal87
Copy link
Member Author

khushal87 commented Jun 8, 2021

@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 universe directory has the universe components docs and props.
  • The main directory has the main package props and docs.
  • The repo directory has the contributing guidelines and stuff.

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.

@khushal87
Copy link
Member Author

khushal87 commented Jun 8, 2021

@arpitBhalla Thanks for your views, currently the docs have the same pattern. I will obviously add nesting for compound components while generating their documentation :)

@pranshuchittora
Copy link
Member

The universe directory has the universe components docs and props.
The main directory has the main package props and docs.
The repo directory has the contributing guidelines and stuff.

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

@khushal87
Copy link
Member Author

Okay, I will check that too, I was a bit zoned out about the playground for the following change.

@pranshuchittora pranshuchittora merged commit 896d4ff into react-native-elements:next Jun 22, 2021
@khushal87 khushal87 deleted the khushal87-dev3 branch July 3, 2021 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants