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

Redo the mud.config.ts page #2994

Closed
qbzzt opened this issue Jul 31, 2024 · 1 comment
Closed

Redo the mud.config.ts page #2994

qbzzt opened this issue Jul 31, 2024 · 1 comment
Assignees

Comments

@qbzzt
Copy link
Contributor

qbzzt commented Jul 31, 2024

Ludens: so as we need to do a bunch of doc work on namespaces here https://mud.dev/config; it would be good to bundle that with a lot of different examples of MUD configs and breaking them down cc @ori Pomerantz
i was trying to explain a MUD config to someone and that page in the doc is one of the most lacking

Frolic: agreed! I think this page could become more of a guide on how to get started with the config (single vs multiple namespaces, how to use each top-level key, etc.)

then a sub page that ideally is generated from the TS doc that explains each config option so we don't have to keep em in sync
the config on this page is wrong anyway! overdue for an update

@qbzzt qbzzt self-assigned this Jul 31, 2024
@qbzzt qbzzt converted this from a draft issue Jul 31, 2024
@qbzzt qbzzt moved this to In Review in Documentation Jul 31, 2024
@qbzzt qbzzt moved this from In Review to Done in Documentation Aug 7, 2024
@holic
Copy link
Member

holic commented Aug 12, 2024

gonna consider this done for now

@holic holic closed this as completed Aug 12, 2024
@github-project-automation github-project-automation bot moved this to Done in MUD Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Status: Done
Development

No branches or pull requests

2 participants