Skip to content

Add project initialization command#3

Merged
baksvell merged 2 commits into
mainfrom
feature/0.2.0-init
Jun 21, 2026
Merged

Add project initialization command#3
baksvell merged 2 commits into
mainfrom
feature/0.2.0-init

Conversation

@baksvell

Copy link
Copy Markdown
Owner

Summary

Adds the new livedoc init command for quickly preparing a project to use LiveDoc.

Changes

  • added livedoc init [path]
  • creates a .livedoc.json configuration file
  • creates the documentation directory
  • creates a starter docs/README.md
  • added support for a custom documentation directory through --docs
  • added safe overwrite behavior through --force
  • prevents the documentation directory from being created outside the project
  • added command help and README documentation
  • added tests for initialization, repeated runs, overwrite behavior, and invalid paths

Examples

livedoc init .
livedoc init . --docs documentation
livedoc init . --force

After initialization:

livedoc symbols .
livedoc . --docs docs

Validation

  • Ruff passed
  • 84 tests passed
  • initialization tested in a clean temporary project
  • existing symbols and documentation-check commands remain compatible

Notes

The package version intentionally remains 0.1.8. It will be updated to 0.2.0 during release preparation after all planned functionality is completed.

@baksvell baksvell merged commit ca1ad87 into main Jun 21, 2026
6 checks passed
@baksvell baksvell deleted the feature/0.2.0-init branch June 21, 2026 09:40
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.

1 participant