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

Sample - Technical Documentation #294

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

Conversation

PKuebler
Copy link

Issue #202

@coveralls
Copy link

coveralls commented Oct 12, 2017

Coverage Status

Coverage remained the same at 94.304% when pulling 7480a74 on PKuebler:master into 00b2c7a on segmentio:master.

@Ajedi32
Copy link
Member

Ajedi32 commented Oct 12, 2017

This seems a little heavy for mere example. Think you could trim it down a bit, so that it only contains the minimal amount of content necessary to demonstrate a documentation site built with Metalsmith?

Also, I'm not sure I like the idea of duplicating Metalsmith's documentation here. Ideally that information should be kept in one place, as I don't want to have to update this example every time Metalsmith's docs change. Might be better to make the documentation in this example about a generic, made-up project, since the idea of these example is just to demonstrate how to build something with Metalsmith; the actual content of the pages themselves isn't important.

@PKuebler
Copy link
Author

Hey,

thanks for your feedback.

yes it is indeed something big. I can also expand the complete style and template stuff.

The idea was to show at an example how it could go and thought the documentation of Metalsmith is not so heavy.

I will create 2-3 pages with a few headings.

@coveralls
Copy link

coveralls commented Oct 12, 2017

Coverage Status

Coverage remained the same at 94.304% when pulling 24cb97b on PKuebler:master into 00b2c7a on segmentio:master.

@coveralls
Copy link

coveralls commented Oct 27, 2017

Coverage Status

Coverage remained the same at 94.304% when pulling 82af68b on PKuebler:master into 00b2c7a on segmentio:master.

@PKuebler
Copy link
Author

I removed a lot of stuff.

@webketje
Copy link
Member

This example still looks useful to me, especially as we don't have any for documentation. I will add & update it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation to revisit To be tackled shortly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants