Make root PHILOSOPHY.md a symlink to the docs philosophy page#13954
Make root PHILOSOPHY.md a symlink to the docs philosophy page#13954yiyixuxu wants to merge 3 commits into
Conversation
The root PHILOSOPHY.md had drifted into a stale duplicate of docs/source/en/conceptual/philosophy.md (which was rewritten in #13808 to cover the single-file model policy and Modular Diffusers). Replace it with a symlink to the docs file, mirroring CONTRIBUTING.md -> contribution.md, so there's a single source of truth. A symlink renders as a path stub (not content) on GitHub, so repoint the links that pointed at blob/main/PHILOSOPHY.md to the rendered docs site: the PR template and the English contribution guide. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
github-actions
Bot
added
documentation
CONTRIBUTING.md is a symlink, so blob/main/CONTRIBUTING.md renders as a path stub on GitHub rather than the guide. Repoint the PR template and README links to the rendered docs page, matching the philosophy/AI-agents links. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The stale-bot comment and the ko/zh contribution guides still linked to
blob/main/{CONTRIBUTING,PHILOSOPHY}.md, which render as path stubs because
those root files are symlinks. Point them at the rendered docs pages
(localized /ko/ and /zh/ for the translations).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
| @@ -1,110 +0,0 @@ | |||
| <!--Copyright 2025 The HuggingFace Team. All rights reserved. | |||
There was a problem hiding this comment.
I realized that this file is still outdated after I updated the philosophy doc in #13808
so made it a symlink (follow same pattern as CONTRIBUTING.md
| - [ ] Did you use an AI agent (Claude Code, Codex, Cursor, etc.) to help with this PR? If so: | ||
| - [ ] Did you point it at the project conventions in [`.ai/`](https://github.com/huggingface/diffusers/tree/main/.ai) (e.g. via `make claude` / `make codex`)? See [Coding with AI agents](https://huggingface.co/docs/diffusers/main/en/conceptual/contribution#coding-with-ai-agents). | ||
| - [ ] Did you self-review the diff against [`.ai/review-rules.md`](https://github.com/huggingface/diffusers/blob/main/.ai/review-rules.md)? | ||
| - [ ] Did you read the [contributor guideline](https://github.com/huggingface/diffusers/blob/main/CONTRIBUTING.md)? |
There was a problem hiding this comment.
pointed all the links to rendered doc page directly
the links correctly open like https://github.com/huggingface/diffusers/blob/main/CONTRIBUTING.md
There was a problem hiding this comment.
| [docs/source/en/conceptual/philosophy.md](./docs/source/en/conceptual/philosophy.md) |
This way, it renders as a path?
|
Hi @yiyixuxu, thanks for the PR! It does not appear to link an issue it fixes. If this PR addresses an existing issue, please add a closing keyword (e.g. |
3 participants
No description provided.