On Mon, Sep 25, 2023 at 12:54:15PM +0100, Ferruh Yigit wrote: > On 9/20/2023 4:48 PM, David Young wrote: > > The separate Getting Started Guides for Linux, FreeBSD, and Windows > > have been consolidated into a single, streamlined guide to simplify the > > user experience and facilitate easier maintenance. > > > > David Young (6): Section 1: Introduction Section 2: Install and Build > > DPDK Section 3: Setting up a System to Run DPDK Applications Section 4: > > Running Applications Section 5: Appendix Section 6: Glossary > > > > Hi David, > > New documentations are not in the toctree, so they are not accessible by > the links in the left column. Sphinx generates warning for this: > WARNING: document isn't included in any toctree > > Also existing per platform documentation is not removed yet. > > I assume both above done intentionally for the development phase of this > documentation, but this is just a reminder in-case not. > > > And not all context seems moved from existing per platform getting > started guides, is there are plan to keep them around for a while as > reference, or move that context to other files? > Part of the work in consolidating these docs is to remove any unnecessary details. After all, these are Getting Started Guides, which should contain only the minimal info for getting started and not much else. The more content we have, the harder the docs become to follow. Some extra content is moved to the appendicies, but I, for one, think we should keep these docs as slim as possible. For example, we should document one way to do things in the main doc. Any alternative methods should be documented via links elsewhere.
For content that is not transferred over as part of this patchset, if there are any concerns about omissions, I think we should discuss them on a case by case basis. Just because something was in the original docs does not mean it needs to go in the new one. :-) /Bruce
