Refactor docs folder by CsatariGergely · Pull Request #4571 · kptdev/kpt

CsatariGergely · 2026-06-04T07:08:53Z

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

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>

netlify · 2026-06-04T07:09:08Z

✅ Deploy Preview for kptdocs ready!

Name	Link
🔨 Latest commit	`1a2bcd7`
🔍 Latest deploy log	https://app.netlify.com/projects/kptdocs/deploys/6a2a936995b17100082721e8
😎 Deploy Preview	https://deploy-preview-4571--kptdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

CsatariGergely · 2026-06-04T07:10:40Z

I'm not sure if we should keep the design-docs folder. It contains KEP kind of documents, but at the moment we do not follow any process like the KEP and I do not know what is the status of these feature ideas as there are no Issues linked to the documents.

Copilot

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.md and relocate design/style-guide content under architecture/.

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>

Copilot

Pull request overview

Copilot reviewed 4 out of 12 changed files in this pull request and generated 2 comments.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 14 changed files in this pull request and generated 1 comment.

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>

Copilot

Pull request overview

Copilot reviewed 7 out of 15 changed files in this pull request and generated 2 comments.

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>

Copilot

Pull request overview

Copilot reviewed 6 out of 14 changed files in this pull request and generated 4 comments.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Catalin-Stratulat-Ericsson · 2026-06-05T08:20:32Z

let me know when all the copilot reviews are handled and the PR is ready to be reviewed. ill have a look at it then @CsatariGergely

…k path Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Copilot

Pull request overview

Copilot reviewed 6 out of 14 changed files in this pull request and generated 1 comment.

liamfallon

I think these 5 documents should be eventually moved into issues and deleted from the repository because they are not visible to us here.

liamfallon · 2026-06-10T08:23:00Z

@CsatariGergely I guess we need to resolve all the cpilot comments before we can merge this.

CsatariGergely · 2026-06-10T09:02:47Z

I think these 5 documents should be eventually moved into issues and deleted from the repository because they are not visible to us here.

I've created

Live inventory to rg Live inventory to rg #4580
OCI support OCI support #4581
Pipeline Merge Pipeline Merge #4582
ARM build ARM build #4583
kpt fn exclude kpt fn exclude #4584

and removed the documents.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Issues created instead of the documents: - Live inventory to rg kptdev#4580 - OCI support kptdev#4581 - Pipeline Merge kptdev#4582 - ARM build kptdev#4583 - kpt fn exclude kptdev#4584 Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Copilot

Pull request overview

Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.

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>

Copilot

Pull request overview

Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Copilot AI review requested due to automatic review settings June 4, 2026 07:08

CsatariGergely requested review from efiacor, kispaljr, liamfallon and mozesl-nokia as code owners June 4, 2026 07:08

dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 4, 2026

Copilot started reviewing on behalf of CsatariGergely June 4, 2026 07:09 View session

CsatariGergely requested a review from Catalin-Stratulat-Ericsson June 4, 2026 07:09

CsatariGergely linked an issue Jun 4, 2026 that may be closed by this pull request

remove kpt/docs #4557

Closed

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread documentation/README.md Outdated

Comment thread documentation/README.md Outdated

Comment thread documentation/README.md Outdated

Comment thread README.md Outdated

Comment thread documentation/README.md Outdated

Apply suggestions from code review

2ebaad3

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>

Copilot AI review requested due to automatic review settings June 4, 2026 11:53

Copilot started reviewing on behalf of CsatariGergely June 4, 2026 11:54 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread documentation/README.md Outdated

Comment thread documentation/README.md Outdated

CsatariGergely added 2 commits June 4, 2026 15:03

Update broken links

69e832b

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Fix notes examples

7403ab3

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Copilot AI review requested due to automatic review settings June 4, 2026 12:59

Copilot started reviewing on behalf of CsatariGergely June 4, 2026 12:59 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread CONTRIBUTING.md Outdated

Apply suggestions from code review

fb0cf3c

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>

Copilot AI review requested due to automatic review settings June 5, 2026 07:31

Copilot started reviewing on behalf of CsatariGergely June 5, 2026 07:31 View session

Copilot AI reviewed Jun 5, 2026

View reviewed changes

Comment thread documentation/README.md Outdated

Comment thread documentation/README.md Outdated

CsatariGergely force-pushed the refactor-docs branch from f0ef8c3 to fb0cf3c Compare June 5, 2026 07:38

Apply suggestions from code review

db30b23

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>

Copilot AI review requested due to automatic review settings June 5, 2026 07:41

Copilot started reviewing on behalf of CsatariGergely June 5, 2026 07:41 View session

Copilot AI reviewed Jun 5, 2026

View reviewed changes

Comment thread documentation/README.md Outdated

Comment thread documentation/README.md

Comment thread documentation/README.md Outdated

Comment thread README.md

Fixing indentation of point 6 in style guide

fa17700

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Update README.md to improve code block formatting and fix license lin…

09a58bf

…k path Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Copilot AI review requested due to automatic review settings June 5, 2026 08:23

Copilot started reviewing on behalf of CsatariGergely June 5, 2026 08:23 View session

Copilot AI reviewed Jun 5, 2026

View reviewed changes

Comment thread documentation/README.md Outdated

liamfallon approved these changes Jun 10, 2026

View reviewed changes

dosubot Bot added the lgtm label Jun 10, 2026

mozesl-nokia approved these changes Jun 10, 2026

View reviewed changes

CsatariGergely added 2 commits June 10, 2026 12:28

Fixing broken links

574e106

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Fix of the italics example

22b350a

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5

Copilot AI review requested due to automatic review settings June 10, 2026 11:24

Copilot started reviewing on behalf of CsatariGergely June 10, 2026 11:24 View session

Removal of old design documents

9a2a65f

Issues created instead of the documents: - Live inventory to rg kptdev#4580 - OCI support kptdev#4581 - Pipeline Merge kptdev#4582 - ARM build kptdev#4583 - kpt fn exclude kptdev#4584 Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Copilot AI reviewed Jun 10, 2026

View reviewed changes

Comment thread documentation/README.md

Comment thread documentation/README.md Outdated

Potential fix for pull request finding

ea76093

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>

Copilot AI review requested due to automatic review settings June 10, 2026 11:34

Copilot started reviewing on behalf of CsatariGergely June 10, 2026 11:34 View session

Copilot AI reviewed Jun 10, 2026

View reviewed changes

Comment thread CONTRIBUTING.md Outdated

Comment thread documentation/content/en/faq.md

dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jun 10, 2026

Removing 06-config-as-data.md references

1a2bcd7

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

efiacor merged commit 6a17aef into kptdev:main Jun 11, 2026
10 checks passed

Conversation

CsatariGergely commented Jun 4, 2026

Uh oh!

netlify Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kptdocs ready!

Uh oh!

CsatariGergely commented Jun 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Catalin-Stratulat-Ericsson commented Jun 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

liamfallon left a comment

Choose a reason for hiding this comment

Uh oh!

liamfallon commented Jun 10, 2026

Uh oh!

CsatariGergely commented Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

netlify Bot commented Jun 4, 2026 •

edited

Loading

CsatariGergely commented Jun 10, 2026 •

edited

Loading