Commit Graph

24 Commits

Author SHA1 Message Date
Marti Bolivar 8b147cd1b9 README.rst: shorten it
This is a bit wordy. Let's let the bold text and links stand on their
own; anybody looking at a README on GitHub or in technical
documentation probably knows what these things mean.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-04-18 16:46:37 -04:00
Ivan kyb Kuvaldin 0cb88e0b5e doc: Fix links to docs.zephyrproject.org
append /index.html, and now browser loads page with CSS.

Signed-off-by: Ivan kyb Kuvaldin <i.kyb@ya.ru>
2019-02-18 17:18:33 -05:00
Anas Nashif 2b9458c378 doc: restructure and create index pages
Move all lead pages to be index pages and create redirect rules from the
old pointers.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00
Anas Nashif 67cd53e028 doc: fix link to contribution guide
Fixed link to the contribution guide.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-01-30 18:38:48 -05:00
Anas Nashif 8ec7c73d2e doc: document slack channel in the main README.rst
Add a link to the slack channel and updated IRC info.

Fixes #11592

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-12-09 09:20:49 -05:00
Anas Nashif 81b272119a docs: fixed documenation pointers
Fixed URL to documentation, now latest docs are under /latest/..
Fixes #9932

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-09-12 12:03:18 -04:00
Carles Cufi cb243eae55 doc: Correct arch spellings in README.rst
Correct a couple of architecture capitalizations and spellings.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-02 18:56:08 +02:00
Carles Cufi ac7753eeae doc: Add getting started to README.rst
Add a Getting Started section in the README.rst for quick and easy
access to what is arguably the most read page of our doc website.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-02 18:56:08 +02:00
Carles Cufi 7555476b4c doc: Replace title with logo in front page
Replace the current title with an image containing the Zephyr logo for
the root README.rst, in order to make the GitHub landing page more
attractive.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-02 18:56:08 +02:00
David B. Kinder 6c6cf23d4d doc: fix misspellings in docs
Caught some misspellings missed by the normal review process.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-23 16:57:33 -04:00
David B. Kinder 0d12b74a29 doc: fix references to mailing lists
The mailing list hosting software change introduced some changes to
where mailing lists are hosted.  Update the docs to point at the
specific sublists rather than the top-level site.  (See issue #7437).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-09 21:10:52 -05:00
David B. Kinder c5615aada4 doc: change https://zephyrproject.org/doc refs
Remove extra indirection to documentation (and required
server link redirection) from https://zephyrproject.org/doc/...
to http://docs.zephyrproject.org/...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-02 18:32:44 -04:00
David B. Kinder a380dce018 doc: fix links to mailing lists
A recent LF change to the Zephyr mailing list hosting software changed
the mailing list names and links to the message archives.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-04-21 06:55:46 -07:00
Henrik Brix Andersen abc47a0717 doc: Add Elixir cross-referencer to resources list
Bootlin is kindly providing an instance of their Elixir source code
cross-referencer tool with an index of the Zephyr kernel and samples
code.

This fixes #1420

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
2018-03-21 19:06:10 -04:00
David B. Kinder fafff0fa78 doc: update links to new zephyrproject.org site
Fix links to content on the new version of zephyrproject.org that moved.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-11-03 19:31:14 -04:00
Andy Gross a5ae3ea672 doc: Add security issue tracking information
This patch adds information about the security related issue
tracking.

Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-10-06 18:12:30 -04:00
Anas Nashif 08f9c23444 doc: add ci build status of master
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-06 09:27:56 -04:00
Anas Nashif 37b9ee0b57 doc: reference github issues instead of jira
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-03 12:09:02 -04:00
David B. Kinder 3b26373de1 doc: Add security doc mention in GitHub README
Zephyr Security WG requests listing a point of contact on the main
GitHub repo README for security-related inquiries. (This section of
the README is also included in the project intro page, via include
directive.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-25 14:22:56 -04:00
David B. Kinder cf17f4870d doc: fix typos and licensing text
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-18 21:42:08 -04:00
David B. Kinder be9f577c21 doc: add CII badge, include README in intro
LF is requesting a Core Infrastructure Initiative evaluation
and badge on our website.  This PR introduces that into our
README.rst on GitHub and also merges content from the
README into our introduction document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-11 08:06:43 -04:00
David B. Kinder 2f41cb8329 doc: misspelling and UTF-8 fixes
More general spelling fixes, and cleaning up stray UTF-8 characters
such as curly-quotes, em- and en-dashes.  Use replacement strings
for |reg| and |trade|.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-05-09 20:15:49 -04:00
David B. Kinder d36996b59c doc: remove :orphan: from README.rst
github doesn't handle sphinx directves (and ends up displaying them)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 15:33:36 -04:00
David B. Kinder e7a54dc645 doc: Add README.rst to project root
Jira: ZEP-2055

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 11:34:35 -04:00