Abraxas-365 / Abraxas-365/langchain-rust
Documentation experience
- 主要语言
- Rust
- 星标
- 1.3k
- 派生
- 177
- PR 合并指标
- 30 天内没有已合并 PR
描述
I am trying to learn about langchain-rust, which looks very interesting, but I'm having some trouble finding some of the documentation and the initial experience is a bit rough. I do appreciate the many linked examples and it's quite possible I caught the documentation in a moment of transition, but I thought I'd give some feedback here.
I'm going to give my experience here in the hope that some of the low hanging fruit can be fixed:
When in github (or any landing page, like the crates.io sidebar) I press the docs link, it goes to this link:
https://langchain-rust.sellie.tech/get-started/quickstart
This gives a not found error.
Going here from the sidebar:
https://langchain-rust.sellie.tech/readme
Gives you an opening page, but the 'next' link goes into this page, which isn't very useful:
https://langchain-rust.sellie.tech/.github
Going to the root of the documentation page, gives you the code of conduct. I think I ended up there by clicking a link somewhere but I'm not entirely sure how I did it anymore, but in any case it's not really the expectation one has for a documentation site:
https://langchain-rust.sellie.tech/
The API docs are well hidden, I can't find a link to them anywhere. I basically have to go to docs.rs myself in order to go through to them. One of the URLs I dug up during my searches was this one:
https://docs.rs/crate/langchain-rust/latest
but that's not actually the API documentation, which is here:
https://docs.rs/langchain-rust/latest/langchain_rust/
Not the issue I'm reporting but some context: what I was really trying to figure out was how to enable some kind of verbose or debugging mode so I can see the actual calls made to the underlying API, but I haven't found that documentation yet, if it exists.
贡献指南
调研方向
The issue reports broken documentation links and a confusing navigation structure. Start by checking the repository's README and any configuration files for documentation site settings (like mkdocs.yml or similar). Verify the broken URLs (e.g., https://langchain-rust.sellie.tech/get-started/quickstart) and see if there are relative links that need updating. The goal is to fix the links so that the documentation landing page and navigation work correctly.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- rust
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 40/100