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

chore(docs): update documentation #6460

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

chore(docs): update documentation #6460

wants to merge 12 commits into from

Conversation

ShGKme
Copy link
Contributor

@ShGKme ShGKme commented Jan 26, 2025

☑️ Resolves

Remove recommendation about Vue.prototype.OC

image

Import documentation

  • Deprecate NextcloudVuePlugin
  • Use new import style + mark old as deprecated
  • Add notes about root
Before After
image image
image image
image image

Update translation docs:

Remove non-actual note about t in attributes

image

Document the current behavior

Before After
image image

Remove "Getting started" with archived vue-example

image

Add versions table

Before After
image image

Update general descriptions

Before After
image image

nitpicks:

  • Consistent badge styles
  • Emojis ✨
Before After
image image

🏁 Checklist

  • ⛑️ Tests are included or are not applicable
  • 📘 Component documentation has been extended, updated or is not applicable
  • 3️⃣ Backport to next requested with a Vue 3 upgrade

Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>

chore(docs): import instructions

Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
@ShGKme ShGKme added 3. to review Waiting for reviews feature: documentation Related to the documentation technical debt labels Jan 26, 2025
@ShGKme ShGKme self-assigned this Jan 26, 2025
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@@ -52,7 +63,7 @@ import { NextcloudVuePlugin } from '@nextcloud/vue'
Vue.use(NextcloudVuePlugin)
```

## Development setup
## 🧑‍💻 Development setup
Copy link
Contributor

Choose a reason for hiding this comment

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

I would maybe wrap all this into a Developing this library or Contributing.
Meaning make this and all following h3.

I think it then makes clearer that this is not usage (app development) but for this library itself.

Copy link
Contributor

@susnux susnux left a comment

Choose a reason for hiding this comment

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

✨ just one comment about headlines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review Waiting for reviews feature: documentation Related to the documentation technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants