mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
fix(docs): update documentation for clarity and structure
- Revised the `getting-started.md` and `documentation-layout.md` files to improve clarity and organization of content. - Enhanced descriptions and added tables for better readability in the `getting-started.md` file. - Updated the `greg-hooks-registry.md` to reflect changes in the hook mapping and clarify the role of `greg_hooks.json`. - Adjusted the `fmf-hook-naming.md` and `fmf-hooks-catalog.md` to emphasize the transition from legacy naming conventions to the new `greg.*` format. This commit aims to improve the overall clarity and usability of the documentation, ensuring users have a better understanding of the framework and its components.
This commit is contained in:
@@ -13,7 +13,7 @@ This folder is the **single source of truth** for the public Docusaurus site. Th
|
||||
|
||||
| Area | Path | Purpose |
|
||||
|------|------|--------|
|
||||
| **Landing** | [`intro` → `/wiki`](/wiki) | Mod author wiki home (`slug: /`). |
|
||||
| **Landing** | [`intro` → `/wiki`](/wiki) | Mod author wiki home (`slug: /` under the docs plugin). |
|
||||
| **Getting started** | [`getting-started.md`](../getting-started.md) | Onboarding (`getting-started`) + this layout page. |
|
||||
| **Workspace** | [`workspace/`](../workspace/index.mdx) | Map of `gregFramework/` repos on disk. |
|
||||
| **Framework** | [`framework/`](../framework/architecture.md) | Architecture, hooks, Hexmod. |
|
||||
@@ -30,7 +30,7 @@ This folder is the **single source of truth** for the public Docusaurus site. Th
|
||||
|
||||
## URLs
|
||||
|
||||
- Doc id `intro` → `/wiki` (root of the docs plugin).
|
||||
- Doc id `intro` → `/wiki` (`slug: /`; legacy `/wiki/docs` redirects here).
|
||||
- Typical doc → `/wiki/<doc-id-path>` (e.g. `mods/framework` → `/wiki/mods/framework`).
|
||||
|
||||
## Language
|
||||
|
||||
Reference in New Issue
Block a user