Skip to content

doc: add new doc website #170

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

Merged
merged 1 commit into from
Mar 4, 2023
Merged

doc: add new doc website #170

merged 1 commit into from
Mar 4, 2023

Conversation

ryantm
Copy link
Owner

@ryantm ryantm commented Feb 26, 2023

  • use mmdoc
  • add github pages action to auto publish
  • do not edit README for now, will follow up with a commit directs people to the doc site

image

@ryantm ryantm force-pushed the rtm-2-26-mmdoc branch 3 times, most recently from d08276f to f57185e Compare February 28, 2023 05:45
@n8henrie
Copy link
Collaborator

n8henrie commented Mar 3, 2023

Not familiar with mmdoc, will check it out

- uses: cachix/install-nix-action@v18
- run: nix build .#doc
- if: success()
uses: crazy-max/ghaction-github-pages@v3
Copy link
Collaborator

Choose a reason for hiding this comment

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

I generally prefer to go with the "official" actions instead of third-party (though I'm totally on board with cachix/install-nix-action). If interested, here's an example using the official actions/configure-pages and actions/deploy-pages actions: https://github.com/n8henrie/n8henrie-rs/blob/f02a99040fc85f791a63d50af7bf367e24df81dd/.github/workflows/docs.yml, the resulting GH pages: https://n8henrie.com/n8henrie-rs/n8henrie/ (was using it as a playground repo for GH docs).

Copy link
Owner Author

Choose a reason for hiding this comment

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

Good call out. I'd rather use some official one too. I'll check these out.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Any idea what is going on here https://github.com/ryantm/agenix/actions/runs/4332366715/jobs/7565206043 ?

Error: Deployment failed, try again later.

@n8henrie
Copy link
Collaborator

n8henrie commented Mar 3, 2023

Not familiar with mmdoc, will check it out

https://github.com/ryantm/mmdoc

Ah, cool -- it's your tool, and what you used for e.g. https://ryantm.github.io/nixpkgs/languages-frameworks/python/ (pages that I've been really grateful for!)

@ryantm ryantm temporarily deployed to github-pages March 4, 2023 17:03 — with GitHub Actions Inactive
@ryantm ryantm temporarily deployed to github-pages March 4, 2023 17:07 — with GitHub Actions Inactive
@ryantm ryantm temporarily deployed to github-pages March 4, 2023 17:36 — with GitHub Actions Inactive
* use mmdoc
* add github pages action to auto publish
* do not edit README for now, will follow up with a commit directs
people to the doc site
@ryantm ryantm merged commit 6a27571 into main Mar 4, 2023
@ryantm ryantm deleted the rtm-2-26-mmdoc branch March 4, 2023 18:46
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