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

Update the instructions created by the markdown generator #9758

Merged
merged 22 commits into from Jan 31, 2022

Conversation

tapia
Copy link
Contributor

@tapia tapia commented Oct 7, 2021

Changelog: Feature: Update content created by the markdown generator.
Docs: conan-io/docs#2380

Closes #9746

(The following screenshot is incomplete, the list of headers is missing. Chrome didn't want me to export the full thing. You get the idea, though).

dillinger io_factory_fetch_html

@tapia tapia requested a review from jgsogo October 7, 2021 12:08
Copy link
Contributor

@jgsogo jgsogo left a comment

Choose a reason for hiding this comment

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

Can you render some examples of packages with more/less dependencies to see how they look like? I'll clone this branch and run examples, too.

OTH, we surely need @lasote here, I'm not familiarized enough with these generators so I'm not sure if this is the best way to use them.

conans/client/generators/markdown.py Outdated Show resolved Hide resolved
@tapia tapia requested a review from lasote October 7, 2021 15:52
@tapia
Copy link
Contributor Author

tapia commented Oct 7, 2021

OTH, we surely need @lasote here, I'm not familiarized enough with these generators so I'm not sure if this is the best way to use them.

I reviewed the template with him a few weeks ago, but I'm adding him as a reviewer so we can get his input

conans/client/generators/markdown.py Outdated Show resolved Hide resolved
conans/client/generators/markdown.py Outdated Show resolved Hide resolved
Copy link
Contributor

@lasote lasote left a comment

Choose a reason for hiding this comment

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

update the image after the changes, there are already missing changes (in the screenshot). It is much easier to review a rendered example.

conans/client/generators/markdown.py Outdated Show resolved Hide resolved
conans/client/generators/markdown.py Outdated Show resolved Hide resolved
conans/client/generators/markdown.py Outdated Show resolved Hide resolved
@jgsogo
Copy link
Contributor

jgsogo commented Jan 31, 2022

Looking good! 👍

How does this look if rendered inside the ConanCenter webpage?

Copy link
Contributor

@lasote lasote left a comment

Choose a reason for hiding this comment

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

👍

@jgsogo
Copy link
Contributor

jgsogo commented Jan 31, 2022

btw, in the image I can see two times the information for boost/1.77.0. One should be enough 😄

@franramirez688 franramirez688 self-assigned this Jan 31, 2022
@franramirez688 franramirez688 added this to the 1.45 milestone Jan 31, 2022
conans/client/generators/markdown.py Outdated Show resolved Hide resolved
conans/client/generators/markdown.py Outdated Show resolved Hide resolved
conans/client/generators/markdown.py Outdated Show resolved Hide resolved
Copy link
Contributor

@jgsogo jgsogo left a comment

Choose a reason for hiding this comment

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

Ok here.

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.

[feature] Update the content of the Markdown generator
5 participants