Currently, the new documentation is on a branch of @H0R5E's fork and can be viewed here.

Hi @H0R5E

I am currently changing this documentation structure to replace docs/ with docs_new/ so that it can merge into the dev branch and build in the previous manner. However WEC-Sim/dev includes some additional changes to the documentation. This is proving difficult to merge properly using git because the docs_new/*.rst files are reorganized and no longer tied to the docs/man/*.rst files. I have not found an easy way to combine changes from both branches.

Do you have any suggestions for merging this fork with any other docs updates on the WEC-Sim/dev branch?

There are few enough documentation changes on dev that it should be possible to do manually, but I wanted to get your thoughts before going that route.

Adam

Hey Adam,

I think the closest thing to automation you can do is use a diff tool (like Meld, for instance) to merge the documents manually (assuming that the files being compared are similar). It would be a bit fiddly to do (you'd need a version of the repo prior to the creation of this branch to use as the base), but it might(?) help.

Alternatively, just note the changes in the docs folder since the docs_new branch was created (using a git diff or equivalent) and try to manually apply them in docs_new.

The file structure has been changed so much that automatic merge will have no chance of working, as you said. So, essentially, we need to manually merge and then overwrite the docs branch.

I have time to help with this if you want. Just let me know.

Mat

Mat,

Thanks for those suggestions. I'll take a try comparing the current dev docs with those when this branch split and inserting the changes into docs_new. I'll let you know if I could use assistance on this.

Adam

@akeeste I'm just providing my vote that this PR be merged into Master and we get feedback from users, onboarding new employees, and our own use. I'm less concerned about the documentation structure and would like to personally find more time to make sure our documentation is up-to-date and accurate.

@kmruehl @yuyihsiang
I made the last few changes that were discussed on 5/21, and per Nathan's approved review, this PR should be ready to merge.

All concurrent changes to the dev docs have been pulled in. @H0R5E, thanks for your suggestions on this.

Adam

@akeeste I just saw the comment from @nathanmtom about merging this directly into master. I like that idea. We can revert this merge and re-merge into master if you like that idea.

@kmruehl I am fine with it in dev and don't see a need to jump our normal workflow. I would rather continue to make updates to the docs now that the new format is set and ensure things are building correctly before merging with master.

I was able to successfully build the new docs locally, but it doesn't seem Travis has autocompiled them yet.

@akeeste, I've having a chat with @kmruehl right now, so we'll discuss getting it compiling again.

@akeeste thanks for lettings us know. @H0R5E is looking into the issue now.

Fixed the build issue with 4737c71