From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id E1FCC1475A; Tue, 8 Nov 2022 15:02:36 +0000 (UTC) Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id BC09714780 for ; Tue, 8 Nov 2022 15:02:33 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: Re: [PATCH v3] Docs: new structure From: "Jenni Nikolaenko" To: devel@spectrum-os.org Date: Tue, 08 Nov 2022 15:02:33 -0000 Message-ID: <166791975371.1913.15771765595007963227@atuin.qyliss.net> In-Reply-To: <20221108090439.gi57cr6igmcaoxkc@x220> References: <20221108090439.gi57cr6igmcaoxkc@x220> User-Agent: HyperKitty on https://spectrum-os.org/ Message-ID-Hash: 6DATRCZ4FVBUO633DXQLIF2SXIBOX7T5 X-Message-ID-Hash: 6DATRCZ4FVBUO633DXQLIF2SXIBOX7T5 X-MailFrom: evgeniia.nikolaenko@unikie.com X-Mailman-Rule-Hits: header-match-devel.spectrum-os.org-0 X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1 X-Mailman-Version: 3.3.5 Precedence: list List-Id: Patches and low-level development discussion Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: X-TUID: 9KKthuSLUM+P > > There's still a change from double spaced to single spaced here. I > > think it's the last one, but it might be a good idea to have a look > > through the diff to make sure that there aren't any more. Fixed. It is better to put one sentence on each line. This makes it easy to move content around, and also easy to spot (too) long sentences. Also, this recommendation here https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line > > I think "Packages" here should be lowercase. Here it is written so as it is used in the official documentation https://nixos.org/ > > I think this page could use some more work to figure out what exactly we > > want to say here. Could we go with something similar to the smaller > > development/index.adoc page from the previous version of your patch? > > I don't want all your other great changes to be held up while we discuss > > a big new chunk of prose like this, so I'd really rather it was kept for > > a future, self-contained patch. Ok, sure, let’s do this as a separate change (patch). I added this general description as my colleagues asked me. Actually, they did not ask to add such a section, but they usually ask about the flow so I decided to describe it once. It helps a lot if guys are not familiar with the process or if it is a new team member. > > This change just unwraps the line, unless I'm missing something? This is the same section in which I had some problems with example attributes :D (long-suffering page) So, I just opened the source code of the current page and made everything by analogy. Actually, there are no changes here. > > Typo in the file name: "patces" Fixed! Т_Т > > I'm not sure this is necessary before starting — it's helpful for > > applying and testing other people's patches, but somebody who just > > wants to submit their own work doesn't need b4. Fixed: Make sure to install and configure the b4 utility for applying and testing other people's patches.