diff --git a/docs/README.md b/docs/README.md index 588a103ea30ee07be697d0117016a71b55632479..e5e355286defb5de99a5d0ffa99106682d2ffbac 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,10 +5,12 @@ documentation. - [Code of conduct](/CODE_OF_CONDUCT.md) - [Glossary](glossary.md) - definitions of commonly used terms + - [Getting started](getting_started.md) - everything you need to get started + with Fuchsia - [Development](development/README.md) - instructions for building, running and testing Fuchsia and software that runs on Fuchsia - [System](the-book/README.md) - documentation for how Fuchsia works - - [Contributing changes](/CONTRIBUTING.md) + - [Contributing changes](https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/CONTRIBUTING.md) Other files in this repository are **system-wide** documentation articles for Fuchsia. **Individual subprojects** have their own documentation within each diff --git a/docs/development/README.md b/docs/development/README.md index bd3a68fb35ccbb9e3c9872bbaa74579ff59b9f0c..edb35058dbba803cce190fbcf2cf546b4a840cb6 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -11,6 +11,7 @@ and debugging Fuchsia and programs running on Fuchsia. - [Getting started](/docs/getting_started.md) - **start here**. This document covers getting the source, building and running Fuchsia. - [Source code](source_code/README.md) + - [fx workflows](workflows/fx.md) - [Multiple device setup](workflows/multi_device.md) - [Pushing a package](workflows/package_update.md) - [Changes that span layers](workflows/multilayer_changes.md) @@ -32,9 +33,11 @@ and debugging Fuchsia and programs running on Fuchsia. - [Python](languages/python/README.md) - [Flutter modules](languages/dart/mods.md) - how to write a graphical module using Flutter + - [New language](languages/new/README.md) - how to bring a new language to Fuchsia ## API + - [README](api/README.md) - Developing APIs for Fuchsia - [Council](api/council.md) - Definition of the API council - [System](api/system.md) - Rubric for designing the Zircon System Interface - [FIDL](api/fidl.md) - Rubric for designing FIDL protocols @@ -60,7 +63,8 @@ This section covers Fuchsia development hardware targets. ## Testing - - [Testing components](tests/test_component.md) + - [Test components](tests/test_component.md) + - [Test environments](tests/environments.md) ## Conventions @@ -69,10 +73,14 @@ This section covers Fuchsia-wide conventions and best practices. - [Documentation standards](/docs/best-practices/documentation_standards.md) - [Endian Issues](source_code/endian.md) and recommendations +## Tracing + + - [Tracing tutorial](tracing/tracing-tutorial.md) + - [Tracing booting Fuchsia](tracing/tracing-boot.md) + ## Miscellaneous - [CTU analysis in Zircon](workflows/ctu_analysis.md) - - [Tracing tutorial](tracing/tracing-tutorial.md) [acer_12]: https://fuchsia.googlesource.com/fuchsia/+/master/zircon/docs/targets/acer12.md "Acer 12" diff --git a/docs/development/source_code/README.md b/docs/development/source_code/README.md index 06850d18870c658a344609c2269efae624f795f4..238c6427eb54533f79624f46515db9d0c9b9ce88 100644 --- a/docs/development/source_code/README.md +++ b/docs/development/source_code/README.md @@ -5,6 +5,8 @@ Fuchsia uses the `jiri` tool to manage git repositories [https://fuchsia.googlesource.com/jiri](https://fuchsia.googlesource.com/jiri). This tool manages a set of repositories specified by a manifest. +See [Source code layout](layout.md) for an overview of how the code is organized. + For how to build, see Fuchsia's [Getting Started](/docs/getting_started.md) doc. ## Creating a new checkout diff --git a/docs/development/tracing/tracing-boot.md b/docs/development/tracing/tracing-boot.md index 4abeeba47889fd58411ffb1e79f8b2617067c9ad..121a3f0f0759fe6fea351672be897c4027bdf3f2 100644 --- a/docs/development/tracing/tracing-boot.md +++ b/docs/development/tracing/tracing-boot.md @@ -70,5 +70,4 @@ For more information on Zircon command line options see [kernel\_cmdline][kernel_cmdline]. -[kernel_cmdline]: https://fuchsia.googlesource.com/fuchsia/+/master/ -zircon/docs/kernel_cmdline.md +[kernel_cmdline]: https://fuchsia.googlesource.com/fuchsia/+/master/zircon/docs/kernel_cmdline.md diff --git a/docs/getting_started.md b/docs/getting_started.md index 42c74becc59247e8e1ea97c60c66e0f5dbdc4f8a..2670d3b325548f689973007eb8db5cf3a6781d3e 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -270,13 +270,15 @@ You may wish to peruse the [testing FAQ](development/workflows/testing_faq.md). ## Contribute changes -* See [CONTRIBUTING.md](/CONTRIBUTING.md). +* See [CONTRIBUTING.md](https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/CONTRIBUTING.md). ## Additional helpful documents * [Fuchsia documentation](README.md) hub * Working with Zircon - [copying files, network booting, log viewing, and more](/zircon/docs/getting_started.md#Copying-files-to-and-from-Zircon) +* [Documentation Standards](best-practices/documentation_standards.md) - best practices + for documentation * [Information on the system bootstrap component](/garnet/bin/sysmgr/). * [Workflow tips and FAQ](development/workflows/workflow_tips_and_faq.md) that help increase productivity. diff --git a/docs/glossary.md b/docs/glossary.md index 91b5757d378fbc64a25d8d6ff3ae639381ec40af..b5972d9fa1b53ad45597d33120ce73023350a3e1 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -180,6 +180,8 @@ user interface framework. A Fuchsia Package is a unit of software distribution. It is a collection of files, such as: manifests, metadata, zero or more executables (e.g. [Components](#component)), and assets. +Individual Fuchsia Packages can be identified using +[fuchsia-pkg URIs](https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/docs/the-book/package_uri.md). #### **fuchsia-pkg URL** diff --git a/docs/the-book/bluetooth_architecture.md b/docs/the-book/bluetooth_architecture.md index 148d6a9532616eaeb7a02716349cf9205abc9db5..9cfc1e510a4eb27e2cb8c58b5f0f8b41e6786acc 100644 --- a/docs/the-book/bluetooth_architecture.md +++ b/docs/the-book/bluetooth_architecture.md @@ -1,6 +1,7 @@ # The Bluetooth System -The Fuchsia Bluetooth system aims to provide a dual-mode implementation of the +The Fuchsia Bluetooth system ([source layout](bluetooth_source_layout.md)) +aims to provide a dual-mode implementation of the Bluetooth Host Subsystem versions 4.2 and 5.0+. This includes - A framework for developing Bluetooth Low Energy applications in central,