Module: Ace::Docs

Defined in:
lib/ace/docs.rb,
lib/ace/docs/cli.rb,
lib/ace/docs/version.rb,
lib/ace/docs/models/document.rb,
lib/ace/docs/atoms/diff_filterer.rb,
lib/ace/docs/atoms/type_inferrer.rb,
lib/ace/docs/cli/commands/status.rb,
lib/ace/docs/cli/commands/update.rb,
lib/ace/docs/organisms/validator.rb,
lib/ace/docs/cli/commands/analyze.rb,
lib/ace/docs/cli/commands/discover.rb,
lib/ace/docs/cli/commands/validate.rb,
lib/ace/docs/atoms/timestamp_parser.rb,
lib/ace/docs/models/analysis_report.rb,
lib/ace/docs/atoms/git_date_resolver.rb,
lib/ace/docs/models/consistency_report.rb,
lib/ace/docs/molecules/change_detector.rb,
lib/ace/docs/molecules/document_loader.rb,
lib/ace/docs/cli/commands/scope_options.rb,
lib/ace/docs/prompts/consistency_prompt.rb,
lib/ace/docs/atoms/terminology_extractor.rb,
lib/ace/docs/atoms/time_range_calculator.rb,
lib/ace/docs/molecules/git_date_resolver.rb,
lib/ace/docs/organisms/document_registry.rb,
lib/ace/docs/prompts/compact_diff_prompt.rb,
lib/ace/docs/molecules/frontmatter_manager.rb,
lib/ace/docs/atoms/frontmatter_free_matcher.rb,
lib/ace/docs/atoms/readme_metadata_inferrer.rb,
lib/ace/docs/cli/commands/analyze_consistency.rb,
lib/ace/docs/prompts/document_analysis_prompt.rb,
lib/ace/docs/organisms/cross_document_analyzer.rb

Defined Under Namespace

Modules: Atoms, CLI, Models, Molecules, Organisms, Prompts Classes: Error

Constant Summary collapse

VERSION = 
'0.34.1'

Class Method Summary collapse

Class Method Details

.config ⇒ Hash

Get configuration using ace-config cascade Follows ADR-022: Configuration Default and Override Pattern Uses Ace::Support::Config.create() for configuration cascade resolution

Returns:

  • (Hash) —

    Configuration hash with defaults merged



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/ace/docs.rb', line 33

def self.config
  @config ||= begin
    gem_root = Gem.loaded_specs["ace-docs"]&.gem_dir ||
      File.expand_path("../..", __dir__)

    resolver = Ace::Support::Config.create(
      config_dir: ".ace",
      defaults_dir: ".ace-defaults",
      gem_path: gem_root
    )

    # Resolve config for docs namespace
    config = resolver.resolve_namespace("docs")
    config.data
  rescue => e
    warn "ace-docs: Could not load config: #{e.class} - #{e.message}" if debug?
    # Fall back to gem defaults instead of empty hash to prevent silent config erasure
    load_gem_defaults_fallback
  end
end

.debug? ⇒ Boolean

Check if debug mode is enabled

Returns:

  • (Boolean) —

    True if debug mode is enabled



78
79
80
 
# File 'lib/ace/docs.rb', line 78

def self.debug?
  ENV["ACE_DEBUG"] == "1" || ENV["DEBUG"] == "1"
end

.reset_config! ⇒ Object

Reset configuration (primarily for testing)



55
56
57
 
# File 'lib/ace/docs.rb', line 55

def self.reset_config!
  @config = nil
end

.root ⇒ Object

Main entry point for ace-docs gem Provides documentation management with frontmatter, change analysis, and intelligent updates



25
26
27
 
# File 'lib/ace/docs.rb', line 25

def self.root
  File.expand_path("../..", __dir__)
end