diff --git a/source/_static/css/theme-overrides.css b/source/_static/css/theme-overrides.css index 99b9845e..7f81d49e 100644 --- a/source/_static/css/theme-overrides.css +++ b/source/_static/css/theme-overrides.css @@ -54,8 +54,8 @@ footer a:hover, footer a:visited:hover {color:#373736} /*Header/Navigatie*/ -.wy-nav-top { background: #373736;} -.wy-nav-top a, .wy-nav-top a:visited {color:#fff;} +.wy-nav-top { color: #373736;} +.wy-nav-top a, .wy-nav-top a:visited {color:#373736;} .wy-nav-top a:hover, .wy-nav-top a:visited:hover {color: #C03E14;} .wy-side-nav-search a.icon.icon-home { font-size: 0; color: transparent;} .wy-side-nav-search {padding:1em;border-right:1px solid} @@ -239,4 +239,4 @@ body { .wy-side-nav-search .wy-dropdown>a.icon img.logo, .wy-side-nav-search>a.icon img.logo {max-width:80px} .wy-menu-vertical a {font-size:14px} -} \ No newline at end of file +} diff --git a/source/intro.rst b/source/intro.rst index 4f46076f..7d729049 100644 --- a/source/intro.rst +++ b/source/intro.rst @@ -4,7 +4,7 @@ Introduction Welcome to the OPNsense documentation & wiki project! The documentation is work in progress and is updated frequently. -If you would like to contribute in anyway, please take a look at our guide +If you would like to contribute in any way, please take a look at our guide how to :doc:`contribute`. .. image:: ./images/opnsense_logo_horizontaal.png @@ -37,12 +37,12 @@ Mission Statement Reading guide ----------------- -While reading the documentation, it's good to know how the various topics are structured, what their purpose is and how -to find what you're looking for. Maybe even more important is what this documentation doesn't offer. +While reading the documentation, it is good to know how the various topics are structured, what their purpose is and how +to find what you are looking for. Maybe even more important is what this documentation does not offer. -If you're looking for deeper insights about networking and best practices in designing them, this might not be the best +If you are looking for deeper insights about networking and best practices in designing them, this might not be the best place to look. Most of our documents and how-to's focus on how to use functionality included in our software and/or one -of it's plugins. Quite some books are written about networking, there are (online) courses available and wikipedia +of its plugins. Quite some books are written about networking, there are (online) courses available and Wikipedia contains a lot of relevant articles as well. Some interesting reads include the fundamentals about the `OSI model `__, `IP addressing `__, `routing `__ and `network address translation `__. @@ -51,10 +51,10 @@ Although we do try to include some context in our documents, there are often ass knowledge on (basic) networking. Like many products and projects, ours grows over time, functionality extends and changes, which sometimes makes it difficult -to find what you need for the version you're using. Although we try to keep our documentation up to date, sometimes text -doesn't reflect reality anymore. If that's the case and you think you found an omission, don't hestitate to open +to find what you need for the version you are using. Although we try to keep our documentation up to date, sometimes text +does not reflect reality anymore. If that is the case and you think you found an omission, do not hesitate to open a report using one of our templates on `GitHub `__ or a pull request -of course if you're able to. +of course if you are able to. Always assume the text is intended for the latest version of our product, in time we might add a version selector in the documentation, but given OPNsense is a security product, we advise to keep it up to date @@ -65,14 +65,14 @@ for an upgrade, this is a useful resource to collect the details. Installation and setup is all about getting you started using one of the target options available. -The next sections should be quite familiair when working with OPNsense, as they reflect the options in the -menu of the product. In case you're not yet used to OPNsense, you can always use the search input in the left corner of +The next sections should be quite familiar when working with OPNsense, as they reflect the options in the +menu of the product. In case you are not yet used to OPNsense, you can always use the search input in the left corner of the screen to find your topic. Both community and third-party plugins have their own area available, although they eventually register into the -same menu structure, it's good to know about possible differences between add-ons and standard functionality. +same menu structure, it is good to know about possible differences between add-ons and standard functionality. The level of support may differ between core functionality, as also explained in the "Support options" section, -feature requests and bugs maybe treated different as well (a lot of questions for a plugin which is being developed +feature requests and bugs may be treated different as well (a lot of questions for a plugin which is being developed by a single person, maybe less active than a group of people improving a plugin together for example). When it comes to building software on top of OPNsense or extending existing functionality, the development