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

Migrate to Docusaurus frontmatter & change all heading levels to use markdown #9

Closed

Conversation

Mysterious-Dev
Copy link
Contributor

@Mysterious-Dev Mysterious-Dev commented Aug 12, 2023

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 12, 2023 15:40 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Aug 12, 2023

Deploying with Cloudflare Pages

Name Result
Last commit: 27a1b1baa9f7c488cd0f41edd142c776d9ad5194
Status: ✅ Deploy successful!
Preview URL: https://fd8c8f4c.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-9.neoforged-docs-previews.pages.dev

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 14, 2023 10:12 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 16, 2023 11:20 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 23, 2023 11:27 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 23, 2023 11:31 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) September 1, 2023 11:52 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) September 22, 2023 14:14 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) September 22, 2023 15:41 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) September 23, 2023 10:41 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 15, 2023 09:28 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 15, 2023 09:32 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 2, 2023 09:25 Active
@Mysterious-Dev Mysterious-Dev marked this pull request as ready for review November 2, 2023 09:26
@Mysterious-Dev
Copy link
Contributor Author

Well, I think I finished the work.

For links, it will be better to do that in a separeted PR (for easy reviews), this PR is already big enough

@sciwhiz12 sciwhiz12 requested a review from a team November 2, 2023 09:38
@ChampionAsh5357
Copy link
Contributor

Why are we removing the titles and only sticking it in the metadata? We can just leave the title as is since it'll be consumed by the parser. The one I think should probably be in the metadata is the description if the first sentence doesn't accurately describe the page.

@Mysterious-Dev
Copy link
Contributor Author

Hey! Sorry for the delay for my reply. I did it out of reflex because I think it's more "cleaner" (as generally, front matters are used for page headers). But, if It's needed to change it, I can.

@ChampionAsh5357
Copy link
Contributor

All good. Though I think its better with the title since it stands out to me that I've clicked the correct page. Since we normally have a quick description of each page below the header, it makes sense to have it there imo.

@Mysterious-Dev
Copy link
Contributor Author

So I should use h1 for the title?

@ChampionAsh5357
Copy link
Contributor

Yep, wrote up a whole style guide if you need it: https://docs.neoforged.net/contributing#style-guide

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 23, 2023 15:58 Active
@Mysterious-Dev
Copy link
Contributor Author

@ChampionAsh5357 It's changed ^^

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 23, 2023 16:02 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.

There's not a file for this, but there likely needs to be a _category_.json file at the top level to order the folders.

@Mysterious-Dev
Copy link
Contributor Author

There's not a file for this, but there likely needs to be a _category_.json file at the top level to order the folders.

Directly in docs folder ?

@ChampionAsh5357
Copy link
Contributor

I believe either in root or the subfolders based on what I understand of the docs. It should be the same process of specifying the sidebar position. If there is an index file, it should just pass the sidebar position to the root.

@ChampionAsh5357
Copy link
Contributor

We could also change from an autogenerated solution to modifying the sidebars.js so that everyone doesn't have to modify the position of every file.

@Mysterious-Dev
Copy link
Contributor Author

We could also change from an autogenerated solution to modifying the sidebars.js so that everyone doesn't have to modify the position of every file.

I think it's the better solution ^^.

@ChampionAsh5357
Copy link
Contributor

Go for it. We'll probably need to change the contributing guidelines too to match that

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 24, 2023 13:08 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) November 24, 2023 13:30 Active
@ChampionAsh5357
Copy link
Contributor

Resolve the merge conflicts and this should be good to go. We'll see when new pages are added whether autogenerated subfolders make sense, or if we should do it manually.

@ChampionAsh5357
Copy link
Contributor

Closing as completed by #65.

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