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(services): support multiple markdown files #515

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

Conversation

gjuchault
Copy link

@gjuchault gjuchault commented Apr 30, 2024

Motivation

This closes #242

The goal of this PR is to introduce "extra files" — documentation. I think this could be valuable to have files from "repository starter" like CONTRIBUTING.md, or more domain-oriented files like feature descriptions, etc.

image
image

Some points that can be discussed:

  • I included a commit to set a volta pin in the package.json to ease development phase (but I can drop this from the PR if you want)
  • I included a commit to fix the start-catalog-locally command that was failing
  • Should this PR also support nested files? I think this could bring visual complexity (how to display them in the sidebar?)

Have you read the [Contributing Guidelines on pull requests]

Yes

Copy link

changeset-bot bot commented Apr 30, 2024

🦋 Changeset detected

Latest commit: cfd35c8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@eventcatalog/types Patch
@eventcatalog/core Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Apr 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
eventcatalog-docs ⬜️ Ignored (Inspect) Visit Preview May 2, 2024 11:47am
eventcatalog-example ⬜️ Ignored (Inspect) Visit Preview May 2, 2024 11:47am

@anaelChardan
Copy link

Would be awesome to have this one!

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.

Add additional documentation markdown to services (and domains)
2 participants