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

Generate namespace pages #439

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Generate namespace pages #439

wants to merge 22 commits into from

Conversation

andrii-balitskyi
Copy link
Contributor

@andrii-balitskyi andrii-balitskyi commented Nov 22, 2024

Closes #399

  • Generate namespace pages
  • Report untitled namespaces

@andrii-balitskyi andrii-balitskyi requested a review from a team as a code owner November 22, 2024 16:14
@seambot seambot requested a review from a team as a code owner November 22, 2024 16:20
src/data/paths.yaml Outdated Show resolved Hide resolved
src/layouts/api-namespace.hbs Outdated Show resolved Hide resolved
src/lib/layout/api-namespace.ts Outdated Show resolved Hide resolved
src/layouts/api-namespace.hbs Outdated Show resolved Hide resolved
src/layouts/api-namespace.hbs Outdated Show resolved Hide resolved
docs/api/acs/README.md Show resolved Hide resolved
docs/api/acs/README.md Outdated Show resolved Hide resolved
src/data/paths.yaml Show resolved Hide resolved
andrii-balitskyi and others added 4 commits November 22, 2024 18:38
Co-authored-by: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com>
Co-authored-by: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com>
@razor-x
Copy link
Contributor

razor-x commented Nov 22, 2024

@andrii-balitskyi We need to update all links (find / replace) to point to this file now instead of api-clients/acs and update the summary so we can preview it on gitbook

* [Access Control Systems](api-clients/acs/README.md)

@andrii-balitskyi
Copy link
Contributor Author

@razor-x replaced all api-clients/acs links with api/acs here f5921a5

Comment on lines +43 to +44
const namespaceMetadata = pathMetadata[path]
if (namespaceMetadata == null) continue
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const namespaceMetadata = pathMetadata[path]
if (namespaceMetadata == null) continue

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why remove this? I thought we needed to skip generating pages for namespaces without metadata from path.yaml.

Copy link
Contributor

@razor-x razor-x Nov 26, 2024

Choose a reason for hiding this comment

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

This line will skip the namespace silently, but this error will fail generation if the namespace meta is missing with a loud error we can fix right? I think we should prefer the error https://github.com/seamapi/docs/pull/439/files#diff-0a3594c2f3f590fc60789732487e494609fc157e29857e33691d171331a8dd6cR23

image


## Resources

### `acs_system`
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to add the links, I think this would be correct.

Suggested change
### `acs_system`
### [`acs_system`](./systems/README.md#acs_system)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me know if I correctly compute the link using pathMetadata c3dbdf0

.gitbook.yaml Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

@andrii-balitskyi This file must remain unchanged or it will break all of the redirects from the old URLs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reverted the file in def5b59

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.

Generate namespace pages
4 participants