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

Cleanup Docs #705

Merged
merged 10 commits into from
Nov 13, 2021
Merged

Cleanup Docs #705

merged 10 commits into from
Nov 13, 2021

Conversation

jwrober
Copy link
Collaborator

@jwrober jwrober commented Nov 9, 2021

Collection of commits to clean up the /docs files after all the legacy files in doc were converted. Also moved some files around to be ready for other documentation issues to be completed in the near future.

Copy link
Contributor

@lmoureaux lmoureaux left a comment

Choose a reason for hiding this comment

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

Developing/Coding sounds redundant and Developing/Contributing sounds like it should be the other way around. What's the rationale for the new structure? What will eventually it look like?

@jwrober
Copy link
Collaborator Author

jwrober commented Nov 10, 2021

What's the rationale for the new structure? What will eventually it look like?

Contributing is for non-coders (people like me who don't get deep into the cpp code, QT framework, AI coding, etc. Documents here are related to the PR process, Release process, getting involved w/ issues, etc. I foresee the list of documents here to be smaller and mostly static once I get the list of issues closed.

Coding is then the opposite of Contributing. This is where the hacking guide, AI, FCDB, and other code related documents go. I can see that this directory will get a lot of documents as we expose more details to the code to the community. I think the more we are open about the code and how to contribute there is going to help a lot.

@lmoureaux
Copy link
Contributor

I would see something like this…

  • Contributing
    • General
    • Translations
    • Code
  • Technical documentation
    • AI
    • FCDB
    • Whatsnot

@jwrober
Copy link
Collaborator Author

jwrober commented Nov 12, 2021

Ok let me do another commit

@lmoureaux lmoureaux merged commit b949ea8 into longturn:master Nov 13, 2021
@jwrober jwrober deleted the docs/contribute branch November 14, 2021 00:15
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