docs: document the Documents feature - #30
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
paths.docs_dir,DAGU_DOCS_DIR,${context.paths.docs_dir}, andDAG_DOCS_DIRdocitemsContext
Companion documentation for dagucloud/dagu#2491 and dagucloud/dagu#2368.
Validation
pnpm buildpnpm test:workerpnpm validate:examplesSummary by cubic
Documents feature is now fully documented: a Web UI for Markdown runbooks with Mermaid, tabs, drafts, search, workspace scoping, and Git Sync. Adds storage configuration (
paths.docs_dir/DAGU_DOCS_DIR), runtime paths (${context.paths.docs_dir}/DAG_DOCS_DIR), and REST/CLI references.New Features
paths.docs_dirandDAGU_DOCS_DIR, defaults, layout, and workspace storage rules.${context.paths.docs_dir}andDAG_DOCS_DIRadded to context/env docs.docitems underdocs/; CLI examples for publish/delete/mv./features/documentsnow points to/web-ui/documents.Migration
paths.docs_dir(or rely on{dags_dir}/docs); optionally setDAGU_DOCS_DIR.docs/to your Git repo if using Git Sync; documents appear asdocitems.Written for commit dd489e1. Summary will update on new commits.