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

Add a guide on the upcoming data maps #46

Merged
merged 16 commits into from
Jan 29, 2024

Conversation

Matyrobbrt
Copy link
Member

@Matyrobbrt Matyrobbrt commented Jan 26, 2024

Depends on neoforged/NeoForge#519 and a PR that makes compostables a data map.


Preview URL: https://pr-46.neoforged-docs-previews.pages.dev

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 26, 2024 13:05 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Jan 26, 2024

Deploying with Cloudflare Pages

Name Result
Last commit: 7657202ee331ba9b4fe5f16e91dcc41c9afc07ce
Status: ✅ Deploy successful!
Preview URL: https://68f08993.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-46.neoforged-docs-previews.pages.dev

Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good for a first pass.

Few comments, but it generally feels difficult to read and understand if you don't already know how the system works. It reads as though there is a lot of assumed knowledge about the system.

docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 26, 2024 16:45 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 26, 2024 16:49 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 26, 2024 16:54 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 26, 2024 19:31 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 26, 2024 20:31 Active
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few more comments as I'm trying to understand this system better.

docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Show resolved Hide resolved
docs/datamaps/index.md Show resolved Hide resolved
docs/datamaps/index.md Show resolved Hide resolved
docs/datamaps/index.md Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 28, 2024 16:24 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 28, 2024 16:46 Active
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One quick comment. I think the rest is fine, though I would like one more member of the doc team to weigh in.

docs/datamaps/index.md Outdated Show resolved Hide resolved
docusaurus.config.js Show resolved Hide resolved
Copy link
Member

@IchHabeHunger54 IchHabeHunger54 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally this looks good. My main complaint is that I find it weird to split the JSON structure off into a separate article. I believe it would make more sense to include that in the main article's Usage section.
I'm also not completely sold on keeping the builtin maps in their own article, however if more systems like this are planned, then it's probably best to keep the article separate.

docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/neo_maps.md Show resolved Hide resolved
docs/datamaps/structure.md Outdated Show resolved Hide resolved
@Matyrobbrt
Copy link
Member Author

I put the json structure in a different page because the main page is for developers and the json structure affects pack devs and users.

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 28, 2024 19:45 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 28, 2024 19:50 Active
Copy link
Member

@XFactHD XFactHD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, just a few minor points

docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/index.md Outdated Show resolved Hide resolved
docs/datamaps/neo_maps.md Outdated Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 29, 2024 07:47 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) January 29, 2024 07:49 Active
@Matyrobbrt Matyrobbrt merged commit 66ccdef into neoforged:main Jan 29, 2024
1 check passed
@Matyrobbrt Matyrobbrt deleted the data-maps branch January 29, 2024 15:41
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.

4 participants