Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

feat: auto-generate configuration from source code#518

Open
ematipico wants to merge 3 commits intomain from
feat/codegen-configuration
Open

feat: auto-generate configuration from source code #518
ematipico wants to merge 3 commits intomain from
feat/codegen-configuration

Conversation

@ematipico
Copy link
Member

@ematipico ematipico commented Jun 6, 2024 •
edited
Loading

Summary

This is my attempt to create the configuration reference page from source code.

The drawback: we lose many examples
The con: we keep one source of truth

I see two options here:

  • Making our doc comments in the source more rich, with markdown examples and more. They will be rendered here.
  • Having use cases and examples in a separate page.

What do you think?

Note

The source code is still junk and needs some polish. For now I would like feedback on what we would like to do and how

chansuke reacted with rocket emoji
Copy link

netlify bot commented Jun 6, 2024 •
edited
Loading

✅ Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 7ba048a
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/6661a0bcf9015d0008bf0996
😎 Deploy Preview https://deploy-preview-518--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member Author

Copy link
Contributor

Sec-ant commented Jun 7, 2024

The drawback: we lose many examples
The con: we keep one source of truth

Aren't "drawback" and "con" the same thing? 😄

I would prefer keeping the options and examples together so I don't have to jump back and forth across pages. And the preview link further determined my thought.

So it seems richer markdown doc comments the way to go. But I get the impression that pulldown-cmark doesn't handle rich markups very well. 🤔
chansuke reacted with laugh emoji

Copy link
Member Author

ematipico commented Jun 7, 2024 •
edited
Loading

Aren't "drawback" and "con" the same thing? 😄

That's how damanged my brain is 😆

I would prefer keeping the options and examples together so I don't have to jump back and forth across pages. And the preview link further determined my thought.

Yeah, that's what the original PR attempts to do, and I don't mind moving better docs and examples in the source code.

So it seems richer markdown doc comments the way to go. But I get the impression that pulldown-cmark doesn't handle rich markups very well. 🤔

I don't think we need pulldown-cmark for now. I think we just need to take the doc comments as they are, and write them.
chansuke reacted with rocket emoji

Ok(())
}

fn generate_markdown_hearer() -> String {
Copy link
Member

@chansuke chansuke Jun 7, 2024

Choose a reason for hiding this comment

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

i noticed a typo in my original function name... 🙏 It should be generate_markdown_header() and sorry for the mistake.

Copy link
Contributor

Sec-ant commented Jun 7, 2024

I don't think we need pulldown-cmark for now. I think we just need to take the doc comments as they are, and write them.

Oh yes, I was wrong.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chansuke chansuke chansuke left review comments

Assignees

No one assigned

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /