Refactor docs folder#4571
Open
CsatariGergely wants to merge 4 commits into
Open
Conversation
The content of the docs folder is not documentation, therefore it was refactored - Docs style guide moved to the README.md of the documentation and was extended with the Nephio documentation guide what is followed by the Porch documentation - ROADMAP.md was removed as it was outdated and we follow the roadmap in a GitHub Project now - The folder was renamed to `architecture` Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
CsatariGergely
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
dosubot
Bot
added
the
size:L
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
I'm not sure if we should keep the |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the repository’s former docs/ content by relocating non-site documentation into a new architecture/ tree, consolidating documentation writing guidance into the documentation site README, and replacing the removed roadmap document with a GitHub Project link.
Changes:
- Replace the root README roadmap link (previously
docs/ROADMAP.md) with a GitHub Project link. - Move/expand the documentation style guide into
documentation/README.md. - Remove outdated
docs/ROADMAP.mdand relocate design/style-guide content underarchitecture/.
Reviewed changes
Copilot reviewed 4 out of 12 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates roadmap guidance to point to a GitHub Project instead of a removed file. |
| documentation/README.md | Adds an expanded documentation style guide to the docs site README. |
| docs/style-guides/docs.md | Removes the old standalone documentation style guide file. |
| docs/ROADMAP.md | Removes the outdated roadmap document. |
| architecture/sync/prototype-controller.md | Adds architecture notes/prototype instructions for RemoteRootSync controller. |
| architecture/style-guides/errors.md | Adds an error message style guide under the new architecture hierarchy. |
| architecture/design-docs/00-template.md | Adds a design doc template under architecture/design-docs. |
| architecture/design-docs/01-live-invenstory-to-rg.md | Adds a design doc about inventory/resourcegroup changes (now under architecture). |
| architecture/design-docs/02-oci-support.md | Adds an OCI support design doc (now under architecture). |
| architecture/design-docs/03-pipeline-merge.md | Adds a pipeline merge design doc (now under architecture). |
| architecture/design-docs/04-arm-build.md | Adds an ARM build design doc (now under architecture). |
| architecture/design-docs/05-kpt-fn-exclude.md | Adds a function-exclude design doc (now under architecture). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5 Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
+45
to
+57
| 4. Use the built-in alerts for notes and alerts | ||
|
|
||
| ```go-html-template | ||
| {{%/* alert title="Warning" color="primary" */%}} | ||
| This is a note. | ||
| {{%/* /alert */%}} | ||
| ``` | ||
|
|
||
| ```go-html-template | ||
| {{%/* alert title="Warning" color="warning" */%}} | ||
| This is a warning. | ||
| {{%/* /alert */%}} | ||
| ``` |
Comment on lines
+61
to
+62
| 6. Do not surround IP addresses, domain names, or any other identifiers with backticks. Use italics | ||
| (\* \*) to mark any inline IP address, domain name, file name, file location, or similar. |
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
| [error message style guide]: docs/style-guides/errors.md | ||
| [documentation style guide]: docs/style-guides/docs.md | ||
| [error message style guide]: architecture/style-guides/errors.md | ||
| [documentation style guide]: documentation/README.md#styl-guide-for-documentation |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The content of the docs folder is not documentation, therefore it was refactored
architecture