Created a docs version of the ReadMe file. #98
Conversation
|
@Veronika271 thank you!! could you please
|
|
Sorry for the delay! I just took everything out of the parent folder and pushed it, but when I try to run mkdocs gh-deploy from the main branch, it still creates a docs website at this link: https://veronika271.github.io/reproschema-py/. I'm not quite sure how to fix that. |
mkdocs.yml
Outdated
| @@ -0,0 +1,11 @@ | |||
| site_name: My Docs | |||
There was a problem hiding this comment.
change the site_name to reproschema-py
There was a problem hiding this comment.
just fixed, thank you!
|
Hi @Veronika271 thank you!! |
.github/workflows/deploy_mkdocs.yml
Outdated
| # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.AUTO_TOKEN }} | ||
| CUSTOM_DOMAIN: optionaldomain.com |
There was a problem hiding this comment.
- Fix typo in site name (reproschema-py) - Remove incorrect CNAME file - Update GitHub workflow to use modern actions and proper permissions
for more information, see https://pre-commit.ci
- Remove internal/ directory with misleading CLAUDE.md files - Remove .serena/ IDE configuration from version control - Add .serena/ and internal/ to .gitignore - Fix GitHub Actions workflow: add mkdocs-material dependency - Fix typos in docs/index.md (resproschema -> reproschema) - Fix incorrect pre-commit command in installation docs - Fix variable name mismatch in redcap2reproschema.md example
- Replace AUTO_TOKEN with built-in GITHUB_TOKEN - Add necessary permissions for release creation - This fixes the 'Bad credentials' error in GitHub Actions
2 participants
I used the content in the ReadMe file to make a new directory which has a Mkdocs website. I'm not quite sure how to continuously host this page instead of having it be open whenever you run makedocs serve, but this should create a working documentation website!