Skip to content

Comments

RDKCOM-5495: RDKBDEV-3334 Add Wan Manager Documentation#180

Open
raslam930 wants to merge 1 commit intordkcentral:mainfrom
raslam930:feature/RDKBDEV-3334
Open

RDKCOM-5495: RDKBDEV-3334 Add Wan Manager Documentation#180
raslam930 wants to merge 1 commit intordkcentral:mainfrom
raslam930:feature/RDKBDEV-3334

Conversation

@raslam930
Copy link

[https://jira.rdkcentral.com/jira/browse/RDKBDEV-3334]
Reason for Change:
To add Component Documentation for Wan Manager
Fix:
Added the documentation
Test Procedure:
None
Signed-off-by: Raheen Aslam [raheen_aslam@comcast.com]

@raslam930 raslam930 requested a review from a team as a code owner December 31, 2025 04:56
@kartikg33
Copy link
Contributor

kartikg33 commented Dec 31, 2025

@raslam930 would it be possible to write up all docs under a new /docs folder instead of in the README?

Please take a look at what we've done for meta-rdk-broadband-apps.

We have a /docs folder to store a structured technical wiki, and we use GitHub pages to host the wiki at a public URL: https://rdkcentral.github.io/meta-rdk-broadband-apps/

We use GitHub workflows to do validation & deployment:

  1. When a PR is raised, we validate that the wiki build doesn't break, and
  2. When a PR is merged to main, we build & deploy the latest docs to the live pages site

@guto86 @S-Parthiban-Selvaraj what do you guys think?

@raslam930
Copy link
Author

raslam930 commented Dec 31, 2025

@raslam930 would it be possible to write up all docs under a new /docs folder instead of in the README?

Please take a look at what we've done for meta-rdk-broadband-apps.

We have a /docs folder to store a structured technical wiki, and we use GitHub pages to host the wiki at a public URL: https://rdkcentral.github.io/meta-rdk-broadband-apps/

We use GitHub workflows to do validation & deployment:

  1. When a PR is raised, we validate that the wiki build doesn't break, and
  2. When a PR is merged to main, we build & deploy the latest docs to the live pages site

@guto86 @S-Parthiban-Selvaraj what do you guys think?

@kartikg33 Yes, we can do that, so shall i raise another PR with docs folder to add the document?

@kartikg33
Copy link
Contributor

@kartikg33 Yes, we can do that, so shall i raise another PR with docs folder to add the document?

@raslam930 upto you whether you would prefer raising a new PR or changing this current PR 👍🏽

@pradeeptakdas pradeeptakdas changed the title RDKBDEV-3334: Add Wan Manager Documentation RDKCOM-5495: RDKBDEV-3334 Add Wan Manager Documentation Jan 16, 2026
@pradeeptakdas
Copy link
Contributor

Hi @guto86

Can you please review and merge this PR?

@pradeeptakdas pradeeptakdas requested a review from guto86 February 18, 2026 18:38
@Ashrafbhanu-k
Copy link

@kartikg33 Yes, we can do that, so shall i raise another PR with docs folder to add the document?

@raslam930 upto you whether you would prefer raising a new PR or changing this current PR 👍🏽

Hi @kartikg33 ,
Added README under new ./docs folder and created new PR - #189 , could you please check this and merge?

@kartikg33
Copy link
Contributor

@kartikg33 Yes, we can do that, so shall i raise another PR with docs folder to add the document?

@raslam930 upto you whether you would prefer raising a new PR or changing this current PR 👍🏽

Hi @kartikg33 ,
Added README under new ./docs folder and created new PR - #189 , could you please check this and merge?

Thanks @Ashrafbhanu-k Can we close this PR then?

@Ashrafbhanu-k
Copy link

@kartikg33 Yes, we can do that, so shall i raise another PR with docs folder to add the document?

@raslam930 upto you whether you would prefer raising a new PR or changing this current PR 👍🏽

@kartikg33 , fixed this by adding README under ./docs folder as suggested and created new PR at #189

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants