Skip to content

docs: document compile execution order#789

Merged
vladdoster merged 1 commit into
zdharma-continuum:mainfrom
oiahoon:docs/document-compile-order
Jul 18, 2026
Merged

docs: document compile execution order#789
vladdoster merged 1 commit into
zdharma-continuum:mainfrom
oiahoon:docs/document-compile-order

Conversation

@oiahoon

@oiahoon oiahoon commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Description

  • add the default and deferred compile phases to the Ice-mod execution order
  • explain when the bang form of nocompile is needed for files created by clone or pull hooks
  • keep the generated man page in sync with the README

Closes #777

Verification

  • confirmed the documented order against the current hook registrations and compile conditions
  • generated a temporary man page with Pandoc and rendered the tracked man page with mandoc
  • parsed the README as GFM HTML
  • ran git diff --check

Comment thread README.md
Comment thread README.md Outdated
@oiahoon
oiahoon force-pushed the docs/document-compile-order branch from 5b045ff to 374441c Compare July 18, 2026 01:50
@vladdoster
vladdoster self-requested a review July 18, 2026 10:00

@vladdoster vladdoster left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Thanks for taking the time to contribute (especially documentation!!).

@vladdoster
vladdoster merged commit b117604 into zdharma-continuum:main Jul 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[doc]: add compile and nocompile'!' to the Order of Execution section

2 participants