Skip to content

Refactor code structure, improve formatting, and update documentation#1

Merged
zTgx merged 7 commits intomainfrom
dev
Apr 3, 2026
Merged

Refactor code structure, improve formatting, and update documentation#1
zTgx merged 7 commits intomainfrom
dev

Conversation

@zTgx
Copy link
Copy Markdown
Member

@zTgx zTgx commented Apr 3, 2026

No description provided.

zTgx added 7 commits April 3, 2026 19:29
- Reorder import statements alphabetically in multiple files including
 examples/index.rs, examples/retrieve.rs, src/client/builder.rs,
  src/client/engine.rs, src/config/mod.rs, src/domain/mod.rs,
  src/domain/toc.rs, src/index/mod.rs, src/index/pipeline/context.rs,
  src/index/pipeline/executor.rs, and src/index/pipeline/mod.rs

- Format long function calls and method chains with proper line breaks
  in examples/retrieve.rs, examples/index.rs, src/client/builder.rs,
  src/client/engine.rs, src/domain/toc.rs, src/domain/tree.rs,
  src/index/incremental/detector.rs, src/index/pipeline/context.rs,
  and src/index/pipeline/executor.rs

- Adjust indentation and line breaks in conditional expressions
  throughout various example files

- Clean up unnecessary blank lines in src/client/builder.rs and
  src/client/engine.rs

- Reorganize module declarations and exports in src/client/mod.rs,
  src/config/mod.rs, and src/domain/mod.rs

- Minor formatting improvements in src/domain/node.rs and
  src/domain/token.rs
Update all IndexStage implementations to return &'static str instead
of &str for better memory management and performance.

feat(index): improve enhance stage summary logging

Modify the enhance stage to properly handle empty summaries by
logging a warning when they occur and proceeding with non-empty
summaries as expected.

refactor(parser): fix content precedence logic in markdown parser

Correct the logic in markdown parser to prioritize preamble content
over content buffer when building raw nodes.

refactor(parser): optimize PDF parser string allocation

Change RawNode creation in PDF parser to use owned String instead
of reference for better memory management.

refactor(toc): remove unused loop variable in processor

Remove unused enumeration variable from TocProcessor chunk iteration.

refactor(retrieval): use is_multiple_of for cleaner modulo check

Replace manual modulo operation with is_multiple_of method for
better readability in context builder.

refactor(ci): update cargo clippy configuration

Change clippy workflow to use -W clippy::all instead of -D warnings
for more comprehensive linting.

chore(linting): add temporary clippy allow attributes

Add temporary clippy and dead code allow attributes to reduce
linting noise during early development phase.
- Remove unused bench.rs file that was only serving as a placeholder
- Update exclude list in Cargo.toml to remove redundant entries
- Remove criterion dependency and benchmark configuration from Cargo.toml
- Clean up project by removing unnecessary benchmark infrastructure
- Remove unused NodeId import from vectorless::domain
- Keep only DocumentTree import as NodeId is not used in the example

refactor(core): remove unused_mutations allow attribute

- Remove unused `#[allow(unused_mutations)]` from src/lib.rs
- Keep other necessary allow attributes for code quality
- Move logo-horizontal.svg from docs/assets/brand/ to docs/design/
- Update README.md to reflect new logo path
- Remove unused icon.svg, logo-dark.svg, and logo.svg files
- Add security policy document outlining vulnerability reporting process
- Include contact email for security issues: beautifularea@gmail.com
- Specify proper reporting procedure and what information to include
- Define response timeline with 48-hour initial response commitment
- Establish disclosure policy for credited vulnerability reports
- Document supported versions with 0.1.x marked as supported
- Replace old description with new marketing-focused description
- Add star call-to-action to encourage community growth
- Maintain existing license and dependency badges
@zTgx zTgx merged commit de89ae2 into main Apr 3, 2026
4 checks passed
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