Skip to content

[Task] Add reference to the SECURITY_CONFIG.md file in configuration.md #1986

@kunalk16

Description

@kunalk16

📝 Objective

Recently the configuration management refactoring was done and the secrets are to be moved from the config.json to security.yml folder.

The documentation for this exists(https://github.com/sipeed/picoclaw/blob/main/pkg/config/SECURITY_CONFIG.md) but there are no references in the user docs leading to that file, I had to do an LLM analysis of the repo to locate this file. Can we add a reference to this file in this file: https://github.com/sipeed/picoclaw/blob/main/docs/configuration.md

Optional to add the link to this document in the error message for missing api key, etc. from code.

📋 To-Do List

🎯 Definition of Done (Acceptance Criteria)

  • Documentation is updated in the README/docs folder.
  • Code follows project linting standards.
  • (If applicable) Basic tests pass.

💡 Context / Motivation

I was trying to look at a github issue and I was unable to configure a fresh installation of picoclaw from the main branch. I had to do an LLM analysis of the repo to locate where to store the api key for version 1 config.

🔗 Related Issues / PRs

  • Fixes #
  • Relates to #

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions