This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 63193b0d7e9 AGENTS.md: point the Documentation bullet at the Ref Guide
authoring docs (#5008)
63193b0d7e9 is described below
commit 63193b0d7e97cee739710f2bb2ea9cf0ea2cf151
Author: Serhiy Bzhezytskyy <[email protected]>
AuthorDate: Sun Oct 4 15:54:19 2026 +0300
AGENTS.md: point the Documentation bullet at the Ref Guide authoring docs
(#5008)
---
AGENTS.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/AGENTS.md b/AGENTS.md
index c51312a85cc..a459b0901f3 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -46,7 +46,7 @@ While README.md and CONTRIBUTING.md are mainly written for
humans, this file is
## Documentation
- For major or breaking changes, add a prominent note in reference guide
major-changes-in-solr-X.adoc
-- Always consider whether a reference-guide page needs updating due to the
new/changed features. Target audience is end user
+- Always consider whether a reference-guide page needs updating due to the
new/changed features. Target audience is end user. To write or edit a page, see
`dev-docs/ref-guide/` and the "About This Guide" page
(`solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc`),
which says how examples are presented to readers
- For changes to build system and other developer-focused changes, consider
updating or adding docs in dev-docs/ folder
- Keep all documentation including javadoc concise
- New classes should have some javadocs
