Uploaded image for project: ' AGL Development'
  1. AGL Development
  2. SPEC-3190

docs-sources repository needs a readme

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Won't Fix
    • Icon: Major Major
    • None
    • None
    • Documentation
    • None

      The main source repository for the documentation (https://github.com/automotive-grade-linux/docs-sources) currently lacks any sort of readme file. I had to go exploring to find the readme in docs-webtemplate and then read the Makefile and some of the javascript in docs-tools to understand how to build the docs for a local test.

      The readme should cover:

      • How to build the docs locally after making changes in a checkout of docs-source.
      • How to contribute (since GitHub pull requests are used instead of Gerrit)
      • Links to mailing list, maintainers, etc

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            Unassigned Unassigned
            paulbarker Paul Barker
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: