Skip to content

chore(directives): add docs - #5665

Merged
susnux merged 1 commit into
masterfrom
docs/directives
Jun 15, 2024
Merged

chore(directives): add docs#5665
susnux merged 1 commit into
masterfrom
docs/directives

Conversation

@ShGKme

@ShGKme ShGKme commented Jun 4, 2024

Copy link
Copy Markdown
Contributor

☑️ 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
Copy Markdown
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
Copy Markdown
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.

@ShGKme ShGKme Jun 14, 2024

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown
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

@susnux susnux left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase though

@susnux
susnux requested a review from Antreesy June 14, 2024 17:48
@ShGKme
ShGKme force-pushed the docs/directives branch from 393b823 to 11456bf Compare June 14, 2024 17:55
@ShGKme

ShGKme commented Jun 14, 2024

Copy link
Copy Markdown
Contributor Author

Rebased onto master, resolved conflicts

Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
@ShGKme
ShGKme force-pushed the docs/directives branch from 11456bf to 1a6f0c9 Compare June 14, 2024 17:57
@ShGKme

ShGKme commented Jun 14, 2024

Copy link
Copy Markdown
Contributor Author

Fixed SPDX comments in new files

@Antreesy Antreesy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks legit

Comment thread styleguide.config.js
content: 'docs/directives/focus.md',
},
{
name: 'Linkify',

Copy link
Copy Markdown
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
Copy Markdown
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
@susnux
susnux deleted the docs/directives branch June 15, 2024 04:50
@ShGKme

ShGKme commented Jun 15, 2024

Copy link
Copy Markdown
Contributor Author

/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