From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Sasha Levin <sashal@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
workflows@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, rostedt@goodmis.org,
kees@kernel.org, konstantin@linuxfoundation.org,
josh@joshtriplett.org
Subject: Re: [RFC 1/2] AI: Add unified AI coding assistant configuration
Date: Mon, 28 Jul 2025 18:56:48 +0200 [thread overview]
Message-ID: <20250728185611.36f5865b@foz.lan> (raw)
In-Reply-To: <aIWNyPMYHXSmJ5qT@lappy>
Em Sat, 26 Jul 2025 22:24:08 -0400
Sasha Levin <sashal@kernel.org> escreveu:
> On Fri, Jul 25, 2025 at 06:15:33PM -0400, Sasha Levin wrote:
> >On Fri, Jul 25, 2025 at 12:27:50PM -0600, Jonathan Corbet wrote:
> >>Sasha Levin <sashal@kernel.org> writes:
> >>
> >>>Create a single source of truth for AI instructions in
> >>>Documentation/AI/main.md with symlinks for all major AI coding
> >>>assistants:
> >>>- CLAUDE.md (Claude Code)
> >>>- .github/copilot-instructions.md (GitHub Copilot)
> >>>- .cursorrules (Cursor)
> >>>- .codeium/instructions.md (Codeium)
> >>>- .continue/context.md (Continue)
> >>>- .windsurfrules (Windsurf)
> >>>- Documentation/AIder.conf.yml (Aider)
> >>>
> >>>Signed-off-by: Sasha Levin <sashal@kernel.org>
> >>>---
> >>> .aider.conf.yml | 1 +
> >>> .codeium/instructions.md | 1 +
> >>> .continue/context.md | 1 +
> >>> .cursorrules | 1 +
> >>> .github/copilot-instructions.md | 1 +
> >>> .windsurfrules | 1 +
> >>> CLAUDE.md | 1 +
> >>> Documentation/AI/main.md | 5 +++++
> >>
> >>So I'm gonna ignore (for now) the substantive issues here to ask: do we
> >>*really* need to introduce Markdown into Documentation/? Are these
> >>things really unable to understand RST? Why not add a file that can be
> >>part of the docs build so people can see the instructions that are being
> >>provided?
> >
> >From my understanding, most of the agents out there expect a markdown
> >file ("CLAUDE.md", ".github/copilot-instructions.md", etc).
> >
> >All the documentation and examples I can find online insist on
> >markdown... I suspect that they will also understand RST, but then we'll
> >be doing something "unsupported".
> >
> >Though in this scenario, maybe even just plain text will be enough?
>
> I've tested providing a RST file instead of markdown to Claude, Copilot,
> and Cursor. All 3 seemed to be okay with it and followed the
> instructions in it.
>
> I'll switch to RST.
Maybe you can also check if aren't there one "unified" file where
others would read, or if are there any efforts to unify them.
I strongly suspect that, if not now, with time, they'll all end
supporting "alien" files for the most popular tools, if they don't
find their own special file name.
Thanks,
Mauro
next prev parent reply other threads:[~2025-07-28 16:56 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-25 17:53 [RFC 0/2] Add AI coding assistant configuration to Linux kernel Sasha Levin
2025-07-25 17:53 ` [RFC 1/2] AI: Add unified AI coding assistant configuration Sasha Levin
2025-07-25 18:19 ` Steven Rostedt
2025-07-25 22:11 ` Sasha Levin
2025-07-25 18:27 ` Jonathan Corbet
2025-07-25 22:15 ` Sasha Levin
2025-07-27 2:24 ` Sasha Levin
2025-07-28 16:56 ` Mauro Carvalho Chehab [this message]
2025-07-25 20:40 ` Kees Cook
2025-07-25 22:25 ` Sasha Levin
2025-07-25 17:53 ` [RFC 2/2] AI: Add initial set of rules and docs Sasha Levin
2025-07-25 20:53 ` Kees Cook
2025-07-25 22:10 ` Sasha Levin
2025-07-28 17:00 ` Mauro Carvalho Chehab
2025-07-25 18:41 ` [RFC 0/2] Add AI coding assistant configuration to Linux kernel Jakub Kicinski
2025-07-25 19:00 ` Steven Rostedt
2025-07-25 19:59 ` Jakub Kicinski
2025-07-25 20:32 ` Dr. David Alan Gilbert
2025-07-25 20:34 ` dan.j.williams
2025-07-25 22:28 ` Sasha Levin
2025-07-28 17:46 ` Steven Rostedt
2025-07-28 18:20 ` dan.j.williams
2025-07-28 22:12 ` Mauro Carvalho Chehab
2025-07-29 0:18 ` Mauro Carvalho Chehab
2025-07-25 21:03 ` Kees Cook
2025-07-28 15:57 ` dan.j.williams
2025-07-28 16:41 ` Kees Cook
2025-07-26 9:07 ` Mario Limonciello
2025-07-26 11:53 ` Sasha Levin
2025-07-26 16:36 ` Kees Cook
2025-07-28 16:49 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250728185611.36f5865b@foz.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=josh@joshtriplett.org \
--cc=kees@kernel.org \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=sashal@kernel.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).