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

WIP update documentation #209

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

Conversation

vilinski
Copy link

after build update, amazing fsdocs tool was able to produce html pages for all markdown files and API reference with search index, without any errors! (well almost)
it produces output folder with the documentation content, which can be pushed to appropriate place

  • add logo.png file to package to the nuget
  • add instructions for documentations build
  • remove FsiRefGen git submodule
  • add proper action to push the output folder content to github pages
  • fix logo image (if the problem is not only local)
  • add styling and/or index.html template?

@haf
Copy link
Member

haf commented Nov 22, 2020

Great! Why remove the submodule though?

@vilinski
Copy link
Author

The essence of this PR is to replace FsiRefGen with fsidocs
I still need to figure out what the FsiRefGen actually does, because I can't run it on my mac. But if it doesn't anything more than converting markdowns to html and generate API reference, then it is better to replace it with fsdocs. It should remove the need to manage a git submodule in a repo and to manage an external code in order to make Hopac releases in the future.

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.

2 participants