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.

Sign up for GitHub

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

Jump to bottom

Static assets doc on 2 pages #3198

Closed
slorber opened this issue Aug 3, 2020 · 8 comments · Fixed by #4095
Closed

Static assets doc on 2 pages #3198

slorber opened this issue Aug 3, 2020 · 8 comments · Fixed by #4095
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. help wanted Asking for outside help and/or contributions to this particular issue or PR. mlh Major League Hacking Fellowship

Comments

@slorber
Copy link
Collaborator

slorber commented Aug 3, 2020

📚 Documentation

The static assets doc from there:
https://v2.docusaurus.io/docs/markdown-features#assets

Should probably be merged into:
https://v2.docusaurus.io/docs/static-assets/#jsx-example

(this is not a doc-only feature btw)

Anyone interested to do this merge and improve our doc?
@slorber slorber added documentation The issue is related to the documentation of Docusaurus status: needs triage This issue has not been triaged by maintainers difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. mlh Major League Hacking Fellowship and removed status: needs triage This issue has not been triaged by maintainers labels Aug 3, 2020
@slorber slorber mentioned this issue Aug 3, 2020
Closed
@teikjun
Copy link
Contributor

teikjun commented Aug 3, 2020

Yes, I'll work on this :)

@anshulrgoyal
Copy link
Contributor

MDX feature page is getting quite big. We should split it and create a new category. We can move it out of Docs catogory also since now Pages also support MDX.

@anshulrgoyal
Copy link
Contributor

anshulrgoyal commented Aug 3, 2020 •
edited
Loading

Creating a new MDX Features category should be nice for users searching and reading docs.

@slorber
Copy link
Collaborator Author

slorber commented Aug 4, 2020 •
edited
Loading

Yes I agree, but we shouldn't use a page for that because the mdx features are version-dependant.

A new sidebar category would be nice. We need a clear distinction of what md features are general, and which ones are doc-related (docs have additional features around linking using .md file paths, relative linking advised so that linking still work once the docs are versioned etc...)

In general, I think we should have way more categories. For example the plugins/themes/presets should imho be first class categories

@anshulrgoyal
Copy link
Contributor

Yeah, making more categories help in organizing docs.

@teikjun teikjun mentioned this issue Aug 4, 2020
Closed
@BogdanDor
Copy link
Contributor

Section assets was moved to https://docusaurus.io/docs/markdown-features/assets in #3975.
Maybe this issue not actual anymore and could be closed.

@Josh-Cena
Copy link
Collaborator

We still have https://docusaurus.io/docs/static-assets and https://docusaurus.io/docs/markdown-features/assets. I don't think it's very problematic considering the logic behind them, but the issue is still valid.

@slorber
Copy link
Collaborator Author

slorber commented Nov 3, 2021 •
edited
Loading

Moving everything to markdown-features/assets probably doesn't make sense, considering assets can also be handled in React/pages.

We should probably move all markdown-related things out of https://docusaurus.io/docs/static-assets, and just link the 2 pages together: one is for general knowledge about assets, and the other for md specifics

@BogdanDor BogdanDor mentioned this issue Nov 6, 2021
Closed
@Josh-Cena Josh-Cena mentioned this issue Nov 18, 2021
Merged
@Josh-Cena Josh-Cena linked a pull request Nov 18, 2021 that will close this issue
feat(core): allow sourcing from multiple static directories #4095
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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. help wanted Asking for outside help and/or contributions to this particular issue or PR. mlh Major League Hacking Fellowship
Projects
None yet
Milestone
No milestone
5 participants
@slorber @BogdanDor @anshulrgoyal @teikjun @Josh-Cena