[Bug 273619] Committer's guide: potential for confusion with the currently given paths

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=273619

            Bug ID: 273619
           Summary: Committer's guide: potential for confusion with the
                    currently given paths
           Product: Documentation
           Version: Latest
          Hardware: Any
               URL: https://github.com/freebsd/freebsd-doc/blob/main/docum
                    entation/content/en/articles/committers-guide/_index.a
                    doc#71-for-new-committers
                OS: Any
            Status: New
          Keywords: needs-patch
          Severity: Affects Some People
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: grahamperrin@gmail.com

In <https://docs.freebsd.org/en/articles/committers-guide/#conventions> step 1,
it's not immediately clear that doc/ means the doc tree. 

From step 5 and then step 9 it might be inferred that the first word in a path
represents a tree, however (to the best of my recollection) this approach is
not commonplace. 

In any case: inference is not ideal. Instead, be clear. 

<https://docs.freebsd.org/en/books/fdp-primer/book/#writing-style-be-clear>

-- 
You are receiving this mail because:
You are the assignee for the bug.