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.

Sign up for GitHub

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

Jump to bottom

Change the GitHub Readme file #32

Open
2 of 4 tasks
LydiaFrance opened this issue May 26, 2022 · 1 comment
Open
2 of 4 tasks

Change the GitHub Readme file #32

LydiaFrance opened this issue May 26, 2022 · 1 comment
Assignees
@LydiaFrance
Labels
documentation Improvements or additions to documentation
Milestone
v0.3.1

Comments

@LydiaFrance
Copy link
Collaborator

LydiaFrance commented May 26, 2022 •
edited by griff-rees
Loading

The documentation will live within a Github pages document/wiki with multiple pages. As a result the README.MD file should function as a landing page for someone visiting the repo.

The content in the current README is preserved, it now sits in docs/.

Helpful content:

  • Quick reference for the arguments
  • Link to the proper documentation github page
  • Other website links
  • Prose introduction to the project
@LydiaFrance LydiaFrance added the documentation Improvements or additions to documentation label May 26, 2022
@andrewphilipsmith andrewphilipsmith added this to the v0.3.1 milestone Jun 30, 2022
@andrewphilipsmith
Copy link
Contributor

https://living-with-machines.github.io/alto2txt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@LydiaFrance LydiaFrance

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.3.1
Development

No branches or pull requests
2 participants
@andrewphilipsmith @LydiaFrance