Skip to content

Add includeDirs Option to configuration #28

Closed

Description

@NextDesign1

We have a lot of documentation stored as .txt files. Unfortunately however, all of our CMake files are also stored in .txt files, and we don't want to index those. My current work-around is to rename all of the documentation that we wish to index to .md, and to add .md files to the list of indexable file types. This isn't a great solution however as 1. Our documentation doesn't fallow traditional markdown rules and 2. if a document is updated and we update the repo, it will cause a conflict. It would be great it we could somehow have more fine-grained control over what is an isn't filtered. For instance, it would be nice to have a list of folders to include, rather than exclude. It would also be useful to provide specific filenames that should be ignored, which would allow us to filter out CMakeLists.txt.

My main desire for parsing our documentation is so that the semantic search knows what all of our internal acronyms and terms are, as currently it only provides a rough guess.

What are your thoughts?

Activity

  1. MrDoe commented on Aug 19, 2026

    @MrDoe
    Owner

    Thanks for the suggestion!

    I agree that renaming the documentation is not a good long-term solution. You can already add .txt to includeExtensions and use excludeFiles to ignore specific filenames such as CMakeLists.txt and CMakeCache.txt. A filename like CMakeLists.txt will be excluded regardless of where it appears in the repository, so this should solve the immediate problem without requiring any file renames.

    An includeDirs option does not exist yet, but it would be a useful addition. It would let you limit indexing to selected folders while continuing to apply the existing exclusion rules within them. I’ll treat that as the feature request here.
    Maybe I will also add this feature to the web UI, so that users can simply click on the respective folders they want to have indexed.

    Thanks for raising this.

  2. changed the title [-]Improve filtering[/-] [+]Add includeDirs Option to configuration[/+] on Aug 19, 2026
  3. self-assigned this
    on Aug 19, 2026
  4. MrDoe commented on Aug 19, 2026

    @MrDoe
    Owner

    It is implemented now. You can select the folders via UI or by editing the opencode-rag.json file.

    Image
  5. MrDoe commented on Aug 19, 2026

    @MrDoe
    Owner

    I think about how we can improve the acronym matching. Maybe by building up a glossary and injecting the definitions into the prompt...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions