nlweb-ai/nlweb-net

📝 Release: Docs and Changelog polish

开放

#79 创建于 2025年8月18日

在 GitHub 查看
 (1 条评论) (0 个反应) (0 位负责人)C# (8 个派生)auto 404
docsgood first issuerelease

仓库指标

星标
 (23 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Polish README/docs for Beta 1.0 and add CHANGELOG entry.

Tasks

  • Update README with quickstart (NuGet + Demo container)
  • Document config basics (List/Summarize/Generate, MCP note)
  • Add troubleshooting for common setup issues
  • Write CHANGELOG.md section for 1.0.0-beta.1

Acceptance Criteria

  • New users can install and run the demo in <10 minutes
  • Clear changelog entry for the release

Parent: #76

贡献者指南

研究方向
更新README，包含快速入门指南，涵盖NuGet安装和演示容器设置；记录List/Summarize/Generate查询模式及MCP集成的配置基础知识；添加常见故障排除步骤；并为1.0.0 beta.1版本编写CHANGELOG部分。
技术栈
csharp
领域
documentationrelease
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90