Skip to content

feat: setup dev documents#8663

Merged
nbolton merged 4 commits intomasterfrom
confdocCleanup
Jun 10, 2025
Merged

feat: setup dev documents#8663
nbolton merged 4 commits intomasterfrom
confdocCleanup

Conversation

@sithlord48
Copy link
Copy Markdown
Member

@sithlord48 sithlord48 commented Jun 8, 2025 •
edited
Loading

  • Remove DESKFLOW_RESET_ALL env var mention from the configuration.md , this should have been part of Deskflow-gui add reset option #8563
  • Move user based documentation to doc/user
  • Create basic doc/dev for dev docs
    • Create a basic mainpage.md
    • Create a basic contributing.md
    • Create a basic build.md
  • Deploy dev docs on lands to master
    • arch build does the deploy, added doxygen, graphviz and rsync to the install action for arch like
    • a branch gh-pages is used as our page source, this branch is updated when we land commits to master
    • published to https://deskflow.github.io/deskflow/
    • Deployments should show after landing to master

@whot if you like to check this out. this is how we intend to deploy the "developer" documentation
@laz-001 Please rebase your protocol updates on this when it lands. (should not take long)

@sithlord48 sithlord48 changed the title chore: remove DESKFLOW_RESET_ALL from configuration documentation chore: prepare documentation for dev documents Jun 8, 2025
@sithlord48 sithlord48 mentioned this pull request Jun 8, 2025
Closed
@sithlord48 sithlord48 marked this pull request as draft June 8, 2025 23:24
@sithlord48 sithlord48 changed the title chore: prepare documentation for dev documents chore: setup dev documents Jun 9, 2025
@sithlord48 sithlord48 force-pushed the confdocCleanup branch 2 times, most recently from 547ab4a to f57d8c8 Compare June 9, 2025 01:33
@sithlord48 sithlord48 mentioned this pull request Jun 9, 2025
Closed
@sithlord48 sithlord48 requested a review from nbolton June 9, 2025 01:49
@sithlord48 sithlord48 marked this pull request as ready for review June 9, 2025 01:49
@sithlord48 sithlord48 changed the title chore: setup dev documents feat: setup dev documents Jun 9, 2025
@sithlord48 sithlord48 added ✨ enhancement A suggested change to improve functionality 🤖 ci The item is for our CI 🗒️ task Doesn't directly add new functionality or fix bugs in the program labels Jun 9, 2025
@sithlord48 sithlord48 mentioned this pull request Jun 9, 2025
Closed
nbolton
nbolton previously approved these changes Jun 9, 2025
View reviewed changes
@sithlord48 sithlord48 force-pushed the confdocCleanup branch 2 times, most recently from 2368d8e to cd333d0 Compare June 9, 2025 16:10
@sithlord48 sithlord48 requested a review from nbolton June 9, 2025 16:14
@sithlord48 sithlord48 marked this pull request as draft June 9, 2025 17:38
@sithlord48 sithlord48 marked this pull request as ready for review June 9, 2025 17:46
@laz-001 laz-001 mentioned this pull request Jun 9, 2025
Merged
whot
whot approved these changes Jun 9, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@whot whot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few typos but otherwise this LGTM (ignoring my lack of deep cmake knowledge).

@sithlord48
Copy link
Copy Markdown
Member Author

sithlord48 commented Jun 10, 2025

Thanks @whot i've fixed those issues

@nbolton nbolton merged commit 7b437b8 into master Jun 10, 2025
32 checks passed
@nbolton nbolton deleted the confdocCleanup branch June 10, 2025 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nbolton nbolton nbolton approved these changes

+1 more reviewer

@whot whot whot approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

✨ enhancement A suggested change to improve functionality 🤖 ci The item is for our CI 🗒️ task Doesn't directly add new functionality or fix bugs in the program

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sithlord48 @nbolton @whot