Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Revise the docs to remain in sync with the current changes #489

Open
neon-mmd opened this issue Jan 20, 2024 · 2 comments
Open

📝 Revise the docs to remain in sync with the current changes #489

neon-mmd opened this issue Jan 20, 2024 · 2 comments

Comments

@neon-mmd
Copy link
Owner

Description

Work Expected From The Issue

Revise the documentation in the docs folder located under the codebase (websurfx directory) by providing an explanation for the new features proposed in the recent PR #443. Also, provide an updated installation guide covering the installation steps for compiling the app with the new features.

The files that require to be modified for this issue are:

  • docs/installation.md
  • docs/features.md

Reason Behind The Proposal

The reasoning behind these changes is to provide an up-to-date documentation to the user, which helps improve user experience.

Screenshots

No response

Do you want to work on this issue?

None

Additional information

No response

Copy link

The issue has been unlocked and is now ready for dev. If you would like to work on this issue, you can comment to have it assigned to you. You can learn more in our contributing guide https://github.com/neon-mmd/websurfx/blob/rolling/CONTRIBUTING.md

Copy link

Stale issue message

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 28, 2024
@neon-mmd neon-mmd reopened this Apr 8, 2024
@neon-mmd neon-mmd self-assigned this Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant