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

feat: make docs link to be consistent with Workspace level #550

Merged
merged 2 commits into from
Jul 2, 2024

Conversation

galuszkak
Copy link
Contributor

Hi !

We saw docs inconsistent behavior of links between Workspace, Software System and Container.

Today links for docs on the examples are:

  • /{section.contentTitle}/ - Workspace Docs
  • /{softwareSystem}/sections/{section.order}/ - Software System Docs - because the first *.md document is used for Info page then while no. is 1 but link is /2/ because it's second document not first so this is already misalinged. But it's also inconsistent with Workspace dos which are based on contentTitle.
  • /{softwareSystem}/sections/{component}/{section.order} - Component Docs

This PR propose to make it always based on Content title (so it's also SEO friendly if anyone needs that).

  • /{section.contentTitle}/ - Workspace Docs
  • /{softwareSystem}/sections/{section.contentTitle}/ - Software System Docs
  • /{softwareSystem}/sections/{component}/{section.contentTitle} - Compoent Docs

This should make links predictable and consistent for docs on different levels.

@jp7677
Copy link
Contributor

jp7677 commented Jul 1, 2024

Thanks a lot for the PR, this totally makes sense. Will run a quick test tomorrow and likely merge.

Copy link
Contributor

@jp7677 jp7677 left a comment

Choose a reason for hiding this comment

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

Found a chance for improvement..

@jp7677 jp7677 merged commit b056e8b into avisi-cloud:main Jul 2, 2024
2 checks passed
@jp7677
Copy link
Contributor

jp7677 commented Jul 2, 2024

Thanks a lot, also for the fast response!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants