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(directives): add docs #5665

Merged
merged 1 commit into from
Jun 15, 2024
Merged

chore(directives): add docs #5665

merged 1 commit into from
Jun 15, 2024

Conversation

ShGKme
Copy link
Contributor

@ShGKme ShGKme commented Jun 4, 2024

☑️ Resolves

🖼️ Screenshots

🏚️ Before 🏡 After
image image
image image

New docs

Directives usage

image

Focus

image

Linkify

image

🚧 Tasks

  • Add sections in directives
  • Add general Directives docs about registration
  • Update Tooltip directive doc page
  • Add Focus directive doc page
  • Add Linkify directive doc page

@ShGKme ShGKme added 3. to review Waiting for reviews feature: documentation Related to the documentation labels Jun 4, 2024
@ShGKme ShGKme self-assigned this Jun 4, 2024

Tooltip directive based on [v-tooltip](https://github.com/Akryum/v-tooltip).

Note: it's preferred to use [native HTML title attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) instead for accessibility.
Copy link
Contributor

Choose a reason for hiding this comment

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

should we deprecate it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I dunno, to be honest ⚆_⚆

In theory - yes, because we migrated everywhere in nextcloud-vue already to title. But apps are still using it also because of visual result.

Maybe we should re-check this rule.

Copy link
Contributor Author

@ShGKme ShGKme Jun 14, 2024

Choose a reason for hiding this comment

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

But we can do it after merging docs for already created and not yet marked deprecated directives 👀

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes sure :)

@ShGKme ShGKme added this to the 8.12.1 milestone Jun 9, 2024
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.

Needs a rebase though

@ShGKme
Copy link
Contributor Author

ShGKme commented Jun 14, 2024

Rebased onto master, resolved conflicts

Signed-off-by: Grigorii K. Shartsev <[email protected]>
@ShGKme
Copy link
Contributor Author

ShGKme commented Jun 14, 2024

Fixed SPDX comments in new files

Copy link
Contributor

@Antreesy Antreesy left a comment

Choose a reason for hiding this comment

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

Looks legit

content: 'docs/directives/focus.md',
},
{
name: 'Linkify',
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd love to see component documentations in separate files as well, to keep SFC clean, but something for later maybe

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or at least move it to the end of the file, not the top 🥲

@susnux susnux merged commit a825b9a into master Jun 15, 2024
19 checks passed
@susnux susnux deleted the docs/directives branch June 15, 2024 04:50
@ShGKme
Copy link
Contributor Author

ShGKme commented Jun 15, 2024

/backport to next

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants