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 footer on the main doc page #342

Closed
zvirja opened this issue Nov 30, 2017 · 6 comments
Closed

Update footer on the main doc page #342

zvirja opened this issue Nov 30, 2017 · 6 comments

Comments

@zvirja
Copy link
Contributor

zvirja commented Nov 30, 2017

The footer on the http://nsubstitute.github.io/ page gives credits to the Codebetter, while you're currently using AppVeyor:

NSubstitute CI builds are run using TeamCity kindly hosted by Codebetter.

Probably, it makes sense to update that stuff or remove it, if it's hard to support it 😉

@dtchepak
Copy link
Member

Nice catch! All sorted now -- thanks!

@zvirja
Copy link
Contributor Author

zvirja commented Nov 30, 2017

Thanks for the quick follow-up! 😉

BTW, the Building section is obsolete too 😊 I have the same issues in AutoFixture - .NET Core SDK is constantly mutating always bringing the required features, so our min version of supported VS is constantly increasing and I always forget to update the contribution guide 😅

@dtchepak
Copy link
Member

I've updated the README too with something more general.

I think this makes you the first person to ever read this README! 😂

@zvirja
Copy link
Contributor Author

zvirja commented Nov 30, 2017

Well, I haven't read it entirely.. So badge is still waiting for someone else 😀


One small unrelated question if you don't mind. I'm currently thinking to make a doc site for AutoFixture like you have. I've noticed that you seem to write all the articles on plain html, rather than use transformation from markdown. What is the reason for that? Is that hard to achieve a good look with markdown? Isn't it inconvenient to support a plain html?

I simply want to understand the caveats to consider them as well, if they are..

Thanks 😄

@zvirja
Copy link
Contributor Author

zvirja commented Nov 30, 2017

Oh, it seems that I missed something. It seems that you host doc in this repo, while after compilation it goes to the other repo you have.. Is that so? I was confused, because I saw commits on your behalf to nsubstitute.github.com.

@dtchepak
Copy link
Member

dtchepak commented Nov 30, 2017

We use Jekyll and markdown. The source code for the docs is in this repo, I build it locally and then push to https://github.com/nsubstitute/nsubstitute.github.com which GitHub Pages helpfully serves for us. (I really should automate that push 🤔 )

There's a little more info in the wiki.

Probably the most important aspect for me is that all the code samples are compiled and tested (so they don't get out of date, unlike certain website footers cough ;) ).

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

No branches or pull requests

2 participants