Skip to content

Add reasonable docs#3

Merged
laurentheirendt merged 11 commits intodevelopfrom
docs
Jan 25, 2021
Merged

Add reasonable docs#3
laurentheirendt merged 11 commits intodevelopfrom
docs

Conversation

@exaexa
Copy link
Copy Markdown
Member

@exaexa exaexa commented Jan 22, 2021

There's now a useful README and normal julia docs with incremental tutorial. The latter will probably need a proofread to straighten up some possible grammar/stylistic problems or inefficiencies, comments welcome.

Some related questions:

  • Is the documentation going to "deploy itself" correctly with this config?
  • Is there some way to have julia syntax highlighting in the docs code snippets?

@exaexa
Copy link
Copy Markdown
Member Author

exaexa commented Jan 23, 2021

Anyway, I fixed some english, the docs look usable to me now. </WIP>

@exaexa exaexa changed the title Add reasonable docs [needs proofread & spellcheck] Add reasonable docs Jan 23, 2021
Copy link
Copy Markdown
Contributor

@laurentheirendt laurentheirendt left a comment

Choose a reason for hiding this comment

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

I think the CI generation of the docs is missing ...

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
@exaexa
Copy link
Copy Markdown
Member Author

exaexa commented Jan 25, 2021

I added the docs-deploying scripts from GigaSOM. It needs to be fed a SSH key for deploy as a secret, can you please add it? (I can't access the CI settings.)

@laurentheirendt
Copy link
Copy Markdown
Contributor

Can you provide me the key in PM for user @cylon-x ? https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#travis-ssh

thx 👍

@exaexa exaexa changed the base branch from master to develop January 25, 2021 12:09
@laurentheirendt laurentheirendt merged commit 931c7b1 into develop Jan 25, 2021
@laurentheirendt laurentheirendt deleted the docs branch January 25, 2021 12:11
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