doc: style edits and fixes to guides #25461

greg-fer · 2023-03-03T13:45:32Z

Edited the nRF Connect platform docs for accuracy and style.
Fixed a couple of linking issues.
Also reviewed some general guides the nRF Connect platform docs are making reference to, for style.

I'm planning to review and structure the rest of the general guides in this section at a later date: https://project-chip.github.io/connectedhomeip-doc/guides/index.html . That will also include describing some style elements in https://project-chip.github.io/connectedhomeip-doc/style/index.html

github-actions · 2023-03-03T14:00:11Z

PR #25461: Size comparison from af3fdc5 to 8b1b33d

Full report (1 build for cc32xx)

platform	target	config	section	`af3fdc5`	`8b1b33d`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	643465	643465
			(read/write)	203688	203688
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197088	197088
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930213	930213
			.debug_aranges	87336	87336
			.debug_frame	300024	300024
			.debug_info	20262928	20262928
			.debug_line	`2657820`	`2657820`
			.debug_loc	2800026	2800026
			.debug_ranges	282240	282240
			.debug_str	3023883	3023883
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	105929	105929
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	378514	378514
			.symtab	256560	256560
			.text	535412	535412

github-actions · 2023-03-06T11:01:04Z

PR #25461: Size comparison from 32fb896 to 7cc7d19

Increases (1 build for cc32xx)

platform	target	config	section	`32fb896`	`7cc7d19`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	20262927	20262928	1	0.0

Full report (5 builds for cc32xx, mbed, nrfconnect)

platform	target	config	section	`32fb896`	`7cc7d19`	change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0
			(read only)	643465	643465	0
			(read/write)	203688	203688	0
			.ARM.attributes	44	44	0
			.ARM.exidx	8	8	0
			.bss	197088	197088	0
			.comment	194	194	0
			.data	1480	1480	0
			.debug_abbrev	930213	930213	0
			.debug_aranges	87336	87336	0
			.debug_frame	300024	300024	0
			.debug_info	20262927	20262928	1
			.debug_line	`2657822`	`2657822`	0
			.debug_loc	2800026	2800026	0
			.debug_ranges	282240	282240	0
			.debug_str	3023883	3023883	0
			.ramVecs	780	780	0
			.resetVecs	64	64	0
			.rodata	105929	105929	0
			.shstrtab	232	232	0
			.stab	204	204	0
			.stabstr	441	441	0
			.stack	2048	2048	0
			.strtab	378514	378514	0
			.symtab	256560	256560	0
			.text	535412	535412	0
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224	0
			(read/write)	`2467384`	`2467384`	0
			.bss	215804	215804	0
			.data	5880	5880	0
			.text	1430028	1430028	0
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read only)	4	4	0
			(read/write)	`1167844`	`1167844`	0
			bss	143423	143423	0
			rodata	136352	136352	0
			text	808236	808236	0
	all-clusters-minimal-app	nrf52840dk_nrf52840	(read only)	4	4	0
			(read/write)	1112880	1112880	0
			bss	142579	142579	0
			rodata	113196	113196	0
			text	777384	777384	0
	all-clusters-app	nrf7002dk_nrf5340_cpuapp	(read only)	4	4	0
			(read/write)	1372848	1372848	0
			bss	105902	105902	0
			rodata	213740	213740	0
			text	767724	767724	0

docs/guides/chip_tool_guide.md

github-actions · 2023-03-07T08:51:35Z

PR #25461: Size comparison from fc0e4a2 to ded7969

Increases (1 build for cc32xx)

platform	target	config	section	`fc0e4a2`	`ded7969`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	`2026706`	20267068	1	0.0

Full report (1 build for cc32xx)

platform	target	config	section	`fc0e4a2`	`ded7969`	change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0
			(read only)	644425	644425	0
			(read/write)	203688	203688	0
			.ARM.attributes	44	44	0
			.ARM.exidx	8	8	0
			.bss	197088	197088	0
			.comment	194	194	0
			.data	1480	1480	0
			.debug_abbrev	930235	930235	0
			.debug_aranges	87336	87336	0
			.debug_frame	300028	300028	0
			.debug_info	`2026706`	20267068	1
			.debug_line	2659698	2659698	0
			.debug_loc	2802749	2802749	0
			.debug_ranges	282952	282952	0
			.debug_str	3023892	3023892	0
			.ramVecs	780	780	0
			.resetVecs	64	64	0
			.rodata	105929	105929	0
			.shstrtab	232	232	0
			.stab	204	204	0
			.stabstr	441	441	0
			.stack	2048	2048	0
			.strtab	378514	378514	0
			.symtab	256624	256624	0
			.text	536372	536372	0

docs/guides/nrfconnect_examples_configuration.md

docs/guides/nrfconnect_examples_software_update.md

github-actions · 2023-03-07T16:39:43Z

PR #25461: Size comparison from 2a6f4ef to 7209c04

Decreases (1 build for cc32xx)

platform	target	config	section	`2a6f4ef`	`7209c04`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	20267068	20267066	-2	-0.0

Full report (3 builds for cc32xx, qpg)

platform	target	config	section	`2a6f4ef`	`7209c04`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0	0.0
			(read only)	644425	644425	0	0.0
			(read/write)	203688	203688	0	0.0
			.ARM.attributes	44	44	0	0.0
			.ARM.exidx	8	8	0	0.0
			.bss	197088	197088	0	0.0
			.comment	194	194	0	0.0
			.data	1480	1480	0	0.0
			.debug_abbrev	930235	930235	0	0.0
			.debug_aranges	87336	87336	0	0.0
			.debug_frame	300028	300028	0	0.0
			.debug_info	20267068	20267066	-2	-0.0
			.debug_line	2659698	2659698	0	0.0
			.debug_loc	2802749	2802749	0	0.0
			.debug_ranges	282952	282952	0	0.0
			.debug_str	3023892	3023892	0	0.0
			.ramVecs	780	780	0	0.0
			.resetVecs	64	64	0	0.0
			.rodata	105929	105929	0	0.0
			.shstrtab	232	232	0	0.0
			.stab	204	204	0	0.0
			.stabstr	441	441	0	0.0
			.stack	2048	2048	0	0.0
			.strtab	378514	378514	0	0.0
			.symtab	256624	256624	0	0.0
			.text	536372	536372	0	0.0
qpg	lighting-app	qpg6105+debug	(read/write)	1152020	1152020	0	0.0
			.bss	99812	99812	0	0.0
			.data	852	852	0	0.0
			.text	599116	599116	0	0.0
	lock-app	qpg6105+debug	(read/write)	1119084	1119084	0	0.0
			.bss	96292	96292	0	0.0
			.data	864	864	0	0.0
			.text	566184	566184	0	0.0

github-actions · 2023-03-13T08:41:59Z

PR #25461: Size comparison from bc8c9ec to 4726afc

Full report (1 build for cc32xx)

platform	target	config	section	`bc8c9ec`	`4726afc`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645097	645097
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930293	930293
			.debug_aranges	87384	87384
			.debug_frame	300248	300248
			.debug_info	20275632	20275632
			.debug_line	2660982	2660982
			.debug_loc	2804957	2804957
			.debug_ranges	283168	283168
			.debug_str	3026158	3026158
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	105993	105993
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	379204	379204
			.symtab	256912	256912
			.text	536984	536984

github-actions · 2023-03-14T08:38:21Z

PR #25461: Size comparison from c1810b6 to e347370

Decreases (1 build for cc32xx)

platform	target	config	section	`c1810b6`	`e347370`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	20245969	20245968	-1	-0.0

Full report (1 build for cc32xx)

platform	target	config	section	`c1810b6`	`e347370`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0	0.0
			(read only)	645489	645489	0	0.0
			(read/write)	203848	203848	0	0.0
			.ARM.attributes	44	44	0	0.0
			.ARM.exidx	8	8	0	0.0
			.bss	197248	197248	0	0.0
			.comment	194	194	0	0.0
			.data	1480	1480	0	0.0
			.debug_abbrev	930293	930293	0	0.0
			.debug_aranges	87384	87384	0	0.0
			.debug_frame	300248	300248	0	0.0
			.debug_info	20245969	20245968	-1	-0.0
			.debug_line	`2660979`	`2660979`	0	0.0
			.debug_loc	2804911	2804911	0	0.0
			.debug_ranges	283168	283168	0	0.0
			.debug_str	`3026947`	`3026947`	0	0.0
			.ramVecs	780	780	0	0.0
			.resetVecs	64	64	0	0.0
			.rodata	106009	106009	0	0.0
			.shstrtab	232	232	0	0.0
			.stab	204	204	0	0.0
			.stabstr	441	441	0	0.0
			.stack	2048	2048	0	0.0
			.strtab	380271	380271	0	0.0
			.symtab	257312	257312	0	0.0
			.text	537360	537360	0	0.0

github-actions · 2023-03-15T08:44:11Z

PR #25461: Size comparison from 12bcb2c to 8b5cd4a

Full report (1 build for cc32xx)

platform	target	config	section	`12bcb2c`	`8b5cd4a`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645489	645489
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930293	930293
			.debug_aranges	87384	87384
			.debug_frame	300248	300248
			.debug_info	20245969	20245969
			.debug_line	`2660979`	`2660979`
			.debug_loc	2804911	2804911
			.debug_ranges	283168	283168
			.debug_str	`3026947`	`3026947`
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	106009	106009
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380271	380271
			.symtab	257312	257312
			.text	537360	537360

github-actions · 2023-03-15T15:20:10Z

PR #25461: Size comparison from a9e759b to aafa1e2

Full report (1 build for cc32xx)

platform	target	config	section	`a9e759b`	`aafa1e2`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645489	645489
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930293	930293
			.debug_aranges	87384	87384
			.debug_frame	300248	300248
			.debug_info	20245969	20245969
			.debug_line	`2660979`	`2660979`
			.debug_loc	2804911	2804911
			.debug_ranges	283168	283168
			.debug_str	`3026947`	`3026947`
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	106009	106009
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380271	380271
			.symtab	257312	257312
			.text	537360	537360

Edited the nRF Connect platform docs and the building guide for style. Fixed several linking issues. Signed-off-by: Grzegorz Ferenc <[email protected]>

github-actions · 2023-03-16T08:37:23Z

PR #25461: Size comparison from 7a52877 to e011c7e

Full report (2 builds for cc32xx, mbed)

platform	target	config	section	`7a52877`	`e011c7e`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645489	645489
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930293	930293
			.debug_aranges	87384	87384
			.debug_frame	300248	300248
			.debug_info	20245968	20245968
			.debug_line	`2660979`	`2660979`
			.debug_loc	2804909	2804909
			.debug_ranges	283168	283168
			.debug_str	`3026947`	`3026947`
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	106009	106009
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380271	380271
			.symtab	257312	257312
			.text	537360	537360
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224
			(read/write)	`2468312`	`2468312`
			.bss	215964	215964
			.data	5880	5880
			.text	1430956	1430956

* doc: style edits and fixes to guides Edited the nRF Connect platform docs and the building guide for style. Fixed several linking issues. Signed-off-by: Grzegorz Ferenc <[email protected]> * Restyled by prettier-markdown --------- Signed-off-by: Grzegorz Ferenc <[email protected]> Co-authored-by: Restyled.io <[email protected]>

github-actions bot added the documentation Improvements or additions to documentation label Mar 3, 2023

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from be00440 to 8b1b33d Compare March 3, 2023 13:49

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from 8b1b33d to 7cc7d19 Compare March 6, 2023 10:14

LuDuda self-requested a review March 6, 2023 10:54

bzbarsky-apple approved these changes Mar 6, 2023

View reviewed changes

docs/guides/chip_tool_guide.md Outdated Show resolved Hide resolved

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from 7cc7d19 to ded7969 Compare March 7, 2023 08:34

markaj-nordic approved these changes Mar 7, 2023

View reviewed changes

docs/guides/nrfconnect_examples_configuration.md Outdated Show resolved Hide resolved

docs/guides/nrfconnect_examples_software_update.md Outdated Show resolved Hide resolved

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from ded7969 to 7209c04 Compare March 7, 2023 15:45

pullapprove bot requested review from amitnj, andy31415, arkq, Byungjoo-Lee, chrisdecenzo, chshu, chulspro, cliffamzn, CodeChronos928, Damian-Nordic, dhrishi, electrocucaracha, emargolis, gjc13, harimau-qirex, harsha-rajendran, hawk248 and jelderton March 8, 2023 09:32

pullapprove bot requested review from selissia, sharadb-amazon, tcarmelveilleux, tecimovic and vijs March 8, 2023 09:32

pullapprove bot added the review - pending label Mar 8, 2023

pullapprove bot requested review from xylophone21, younghak-hwang and yufengwangca March 8, 2023 09:32

LuDuda approved these changes Mar 9, 2023

View reviewed changes

pullapprove bot added review - approved and removed review - pending labels Mar 9, 2023

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from a8fe1be to 4726afc Compare March 13, 2023 08:31

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from 4726afc to e347370 Compare March 14, 2023 08:25

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from e347370 to 8b5cd4a Compare March 15, 2023 08:35

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from 8b5cd4a to aafa1e2 Compare March 15, 2023 15:04

greg-fer and others added 2 commits March 16, 2023 09:18

doc: style edits and fixes to guides

b73d3da

Edited the nRF Connect platform docs and the building guide for style. Fixed several linking issues. Signed-off-by: Grzegorz Ferenc <[email protected]>

Restyled by prettier-markdown

e011c7e

greg-fer force-pushed the doc_nrfconnect_style_fixes branch from aafa1e2 to e011c7e Compare March 16, 2023 08:18

kkasperczyk-no approved these changes Mar 16, 2023

View reviewed changes

kkasperczyk-no enabled auto-merge (squash) March 16, 2023 12:25

kkasperczyk-no disabled auto-merge March 16, 2023 12:25

kkasperczyk-no enabled auto-merge (squash) March 16, 2023 12:26

kkasperczyk-no merged commit 1837739 into project-chip:master Mar 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: style edits and fixes to guides #25461

doc: style edits and fixes to guides #25461

greg-fer commented Mar 3, 2023

github-actions bot commented Mar 3, 2023

github-actions bot commented Mar 6, 2023

github-actions bot commented Mar 7, 2023

github-actions bot commented Mar 7, 2023

github-actions bot commented Mar 13, 2023

github-actions bot commented Mar 14, 2023

github-actions bot commented Mar 15, 2023

github-actions bot commented Mar 15, 2023

github-actions bot commented Mar 16, 2023

doc: style edits and fixes to guides #25461

doc: style edits and fixes to guides #25461

Conversation

greg-fer commented Mar 3, 2023

github-actions bot commented Mar 3, 2023

github-actions bot commented Mar 6, 2023

github-actions bot commented Mar 7, 2023

github-actions bot commented Mar 7, 2023

github-actions bot commented Mar 13, 2023

github-actions bot commented Mar 14, 2023

github-actions bot commented Mar 15, 2023

github-actions bot commented Mar 15, 2023

github-actions bot commented Mar 16, 2023