docs: redistribute faq content to relevant sections (fixes #39) #42
Conversation
|
Hi @asanvaq , I have made the necessary changes and made a commit. Please verify and let me know if any changes are needed. Thanks. |
|
|
||
| ### Package naming | ||
|
|
||
| Package names must be the same as the package names in the archive, so that |
There was a problem hiding this comment.
This is redundant. It's basically saying: "the package names must be the same as the package names".
It might have made sense in the FAQ, but this page is about slices, and thus "naming convention" refers to the slices naming convention. There's no package naming, cause there are no packages in chisel, only references to the package a slice comes from
|
PS this change also makes the "modes-of-operation" page look ugly due to varying lengths of text across steps |
| definitions<slice_definitions_ref>` while validating the release and checking for | ||
| conflicting paths across packages. Slice definitions for each Ubuntu release are | ||
| located in the corresponding `ubuntu-XX.YY` branch of the {{chisel_releases_repo}}. |
There was a problem hiding this comment.
This information is already in docs/reference/chisel-releases/index.md, there is no need to repeat it here.
| The supported archives are described at | ||
| {ref}`chisel_yaml_format_spec_archives`; non-Ubuntu archives and PPAs are not | ||
| supported. |
There was a problem hiding this comment.
This information is already in docs/reference/chisel-releases/slice-definitions.md, so there is no need to repeat it.
3 participants
Description
This PR addresses issue #39 by redistributing the FAQ content into relevant documentation sections to improve context and discoverability.
Changes
docs/explanation/faq.md.docs/explanation/mode-of-operation.mdanddocs/explanation/slices.md.docs/explanation/index.mdto remove the reference to the FAQ page.QA Steps
docs/explanation/faq.mdis deleted.docs/explanation/index.mdto ensure the FAQ link is removed.docs/explanation/mode-of-operation.mdanddocs/explanation/slices.md.